Last active
January 3, 2016 11:52
-
-
Save pflannery/5291f51c3ca39c48164c to your computer and use it in GitHub Desktop.
Yuidoc example
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* ###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) | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"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" | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
yuidoc .
in root.note: if you only want the data.json then add the
"parseOnly": "true"
option to the options section of yuidoc.json