Skip to content

minor release

Compare
Choose a tag to compare
@caridy caridy released this 22 Apr 01:47
· 199 commits to master since this release

PR #222: adding support for preprocessor config

This adds support for custom pre-processors, e.g.: yuidoc.json:

{
    "options": {
        "preprocessor": ["./path/to/custom_doc_preprocessor.js", "yuidoc-preprocessor-foo"]
    }
}

in the example above, you can create an app specific preprocessor, plus a npm package that implements a preprocessor.

PR #227: Allow @param and @return descriptions to be preceded by a newline.

This fixes the possibility of having more readable comment format:

/**
Main description.

@method foo

@param {String} bar
    This is the bar param.

@param {String} baz
    This is the baz param.

@return {Boolean}
    Whether or not bar and baz got fooed.
**/

Acknowledgements

Special thanks to @limikael and @rgrove for their contributions to this release.