Skip to content

Instantly share code, notes, and snippets.

@pflannery
Last active January 3, 2016 11:52
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save pflannery/5291f51c3ca39c48164c to your computer and use it in GitHub Desktop.
Save pflannery/5291f51c3ca39c48164c to your computer and use it in GitHub Desktop.
Yuidoc example
/**
* ###library 6000 test
*
* @module library6000
*/
/**
* Some class
*
* @class SomeClass
*/
class SomeClass {
constructor(data) {
this.data = data;
}
/**
* A helper method to check if the passed argument is an instanceof a {Task}
*
* @method isTask
*
* @param {Task} item - The possible instance of the {Task} that we want to check
* @return {Boolean} Whether or not the item is a {Task} instance.
*/
static isTask (item) {
return (item && item.type === 'task') || (item instanceof Task)
}
}
{
"name": "My Library 6000",
"description": "Library 6000 description",
"version": "3.5.0",
"url": "http://yuilibrary.com/",
"options": {
"linkNatives": "true",
"nocode": true,
"attributesEmit": "true",
"selleck": "true",
"ignorePaths": [ "simpleyui" ],
"paths": "*/js",
"outdir": "./out",
"markdown": "default"
}
}
@pflannery
Copy link
Author

  • create yuidoc.json in the root and copy contents from above yuidoc.json
  • create app.js in the root and copy contents from above app.js
  • run yuidoc . in root.

note: if you only want the data.json then add the "parseOnly": "true" option to the options section of yuidoc.json

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment