Newer
Older
pixi.js / gulp / util / jsdoc.conf.json
@Mathias Latournerie Mathias Latournerie on 17 May 2015 1 KB proper use of gulp task and updated readme
{
    "tags": {
        "allowUnknownTags": false
    },
    "source": {
        "include": [
            "./src/"
        ],
        "exclude": [
            "./src/polyfill/",
            "./src/core/utils/PolyK.js",
            "./src/spine/SpineRuntime.js"
        ],
        "includePattern": ".+\\.js(doc)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "plugins": [
        // "./tasks/jsdoc-plugins/namealias",
        // "./tasks/jsdoc-plugins/filterpixi",
        // "./tasks/jsdoc-plugins/proptomember",
        // "./tasks/jsdoc-plugins/sourceproxy",
        // "./tasks/jsdoc-plugins/shortlinks",
        "plugins/markdown"
    ],
    "templates": {
        "cleverLinks"   : false,
        "monospaceLinks": false,
        "default"       : {
            "outputSourceFiles" : true
        },
        "systemName"    : "PIXI",
        "footer"        : "Made with ♥ by <a href='http://goodboydigital.com'>Goodboy Digital</a>",
        "copyright"     : "PIXI Copyright © 2013-2015 Mat Groves.",
        "linenums"      : true,
        "collapseSymbols": false
    },
    "markdown"  : {
        "parser"        : "gfm",
        "hardwrap"      : true
    },
    "opts": {
        "encoding"      : "utf8",
        "recurse"       : true,
        "private"       : false,
        "lenient"       : true,
        "destination"   : "./docs",
        "template"      : "./node_modules/jaguarjs-jsdoc"
    }
}