Document plugin API

Created by: nalbion

The writing a plugin docs are very vague. Could you please document the parameters and returns?

/**
 * Assumptions, strategy etc...
 * @param {*} paramsFromGulp (optional) any parameters or config that may be passed from a Gulp script to the plugin
 * @return {no idea} Promise? Vinly? Stream? ????
 */
module.exports = function(paramsFromGulp) {

    /**
     * Assumptions, strategy etc...
     * @param {Vinyl} file - but pretend I have little/no experience with Vinyl or Node
     * @param {string} enc - presumably "utf8" etc
     * @param {function(Error?, Vinyl);WhatDoesItReturn?}
     * @return Promise? Vinly? Stream? ????   Because a callback is passed in, do we need to return anything?
     */
    return through.obj(function(file, enc, cb) {
    }
};