phaser-ce/tasks/jsdoc-conf.json

Phaser CE (Community Edition) is a fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers.

{
  "markdown": {
    "hardwrap": false,
    "parser": "gfm"
  },
  "opts": {
    "debug": true,
    "destination": "./docs",
    "encoding": "utf8",
    "lenient": true,
    "mainpagetitle": "API Documentation",
    "private": false,
    "readme": "./DOCS.md",
    "recurse": true,
    "template": "./resources/docstrap-master/template"
  },
  "plugins": [
    "./tasks/jsdoc-plugins/namealias",
    "./tasks/jsdoc-plugins/proptomember",
    "./tasks/jsdoc-plugins/shortlinks",
    "plugins/markdown"
  ],
  "source": {
    "exclude": [
      "./src/physics/p2/p2.js",
      "./src/pixi/Intro.js",
      "./src/pixi/Outro.js",
      "./src/animation/creature/"
    ],
    "excludePattern": "(^|\\/|\\\\)_",
    "include": [
      "./package.json",
      "./src/Phaser.js",
      "./src/PhaserGlobal.js",
      "./src/animation/",
      "./src/core/",
      "./src/gameobjects/",
      "./src/geom/",
      "./src/input/",
      "./src/loader/",
      "./src/math/",
      "./src/particles/",
      "./src/physics/",
      "./src/pixi/",
      "./src/plugins/",
      "./src/sound/",
      "./src/tilemap/",
      "./src/time/",
      "./src/tween/",
      "./src/utils/"
    ],
    "includePattern": ".+\\.js(doc)?$"
  },
  "tags": {
    "allowUnknownTags": true
  },
  "templates": {
    "cleverLinks": false,
    "collapseSymbols": false,
    "copyright": "Phaser Copyright © 2012-2016 Photon Storm Ltd.",
    "dateFormat": "YYYY-MM-DD",
    "disablePackagePath": true,
    "footer": "",
    "inverseNav": true,
    "linenums": true,
    "logoFile": "",
    "methodHeadingReturns": false,
    "monospaceLinks": false,
    "navType": "vertical",
    "outputSourceFiles": false,
    "outputSourcePath": true,
    "protocol": "html://",
    "search": false,
    "sourceLinkFormat": "https://github.com/photonstorm/phaser-ce/blob/v%s/%s#L%s",
    "sourceRootPath": "./",
    "systemName": "Phaser CE",
    "theme": "phaser"
  }
}