1
2
3

"build": "./node_modules/.bin/jsdoc *.js",
"gen": "node --max_old_space_size=8192 node_modules/jsdoc/jsdoc.js -c jsdoc.conf.json -R ../phaser/README.md",
"json": "jsdoc -c jsdoc.data.json"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

/**
 * check the param is an array
 * @param {array} arr - input parameter
 * @returns boolean
 */
const isArray = (arr) => {
  return Array.isArray(arr);
};

export { isArray };

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

import isArray from './utils';

/** This is a description of the foo function. */
function foo() {
}

/**
 * Represents a book.
 * @constructor
 */
function Article(title, author) {
  console.log(isArray(title));
  return title + author;
}

/**
 * Represents a book.
 * @constructor
 * @param {string} title - The title of the book.
 * @param {string} author - The author of the book.
 */
class Book {
  constructor(props) {
    this.title = props.title;
    this.author = props.author;
  }
  /**
   * say hi to someone
   * @param {string} name - The user name.
   */
  sayHi(name) {
    console.log('Hi ' + name);
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

{
  "tags": {
      "allowUnknownTags": true
  },
  "source": {
      "include": [
          "../phaser/src/",
          "../phaser/plugins/fbinstant"
      ],
      "exclude": [
          "../phaser/src/phaser-arcade-physics.js",
          "../phaser/src/phaser-core.js",
          "../phaser/src/physics/matter-js/poly-decomp/",
          "../phaser/src/physics/matter-js/lib",
          "../phaser/src/polyfills",
          "../phaser/src/phaser-ie9.js"
      ],
      "includePattern": ".+\\.js?$",
      "excludePattern": "(^|\\/|\\\\)_"
  },
  "plugins": [
      "jsdoc-plugins/typedef",
      "jsdoc-plugins/this"
  ],
  "opts": {
      "debug": false,
      "destination": "./json/phaser.json",
      "encoding": "utf8",
      "outputSourceFiles": false,
      "outputSourcePath": true,
      "recurse": true,
      "private": false,
      "lenient": true,
      "sourceType": "script",
      "template": "node_modules/jsdoc-json"
  }
}