Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweak @param comments for API docs #295

Merged
merged 1 commit into from
Dec 10, 2014
Merged

Tweak @param comments for API docs #295

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions lib/builder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -850,7 +850,7 @@ YUI.add('doc-builder', function (Y) {
* @method renderIndex
* @param {Function} cb The callback fired when complete
* @param {String} cb.html The HTML to render this view
* @param {Object} cv.view The View Data
* @param {Object} cb.view The View Data
*/
renderIndex: function (cb) {
var self = this;
Expand All @@ -874,6 +874,8 @@ YUI.add('doc-builder', function (Y) {
* Generates the index.html file
* @method writeIndex
* @param {Callback} cb The callback to execute after it's completed
* @param {String} cb.html The HTML to write index view
* @param {Object} cb.view The View Data
*/
writeIndex: function (cb) {
var self = this,
Expand All @@ -899,7 +901,7 @@ YUI.add('doc-builder', function (Y) {
* @method renderModule
* @param {Function} cb The callback fired when complete
* @param {String} cb.html The HTML to render this view
* @param {Object} cv.view The View Data
* @param {Object} cb.view The View Data
*/
renderModule: function (cb, data, layout) {
var self = this;
Expand Down Expand Up @@ -982,6 +984,8 @@ YUI.add('doc-builder', function (Y) {
* Generates the module files under "out"/modules/
* @method writeModules
* @param {Callback} cb The callback to execute after it's completed
* @param {String} cb.html The HTML to write module view
* @param {Object} cb.view The View Data
*/
writeModules: function (cb, layout) {
layout = layout || 'main';
Expand Down Expand Up @@ -1100,7 +1104,7 @@ YUI.add('doc-builder', function (Y) {
* @method renderClass
* @param {Function} cb The callback fired when complete
* @param {String} cb.html The HTML to render this view
* @param {Object} cv.view The View Data
* @param {Object} cb.view The View Data
*/
renderClass: function (cb, data, layout) {
var self = this;
Expand Down Expand Up @@ -1387,6 +1391,8 @@ YUI.add('doc-builder', function (Y) {
* Generates the class files under "out"/classes/
* @method writeClasses
* @param {Callback} cb The callback to execute after it's completed
* @param {String} cb.html The HTML to write class view
* @param {Object} cb.view The View Data
*/
writeClasses: function (cb, layout) {
layout = layout || 'main';
Expand Down Expand Up @@ -1451,6 +1457,8 @@ YUI.add('doc-builder', function (Y) {
* Generates the syntax files under `"out"/files/`
* @method writeFiles
* @param {Callback} cb The callback to execute after it's completed
* @param {String} cb.html The HTML to write file view
* @param {Object} cb.view The View Data
*/
writeFiles: function (cb, layout) {
layout = layout || 'main';
Expand Down Expand Up @@ -1500,7 +1508,7 @@ YUI.add('doc-builder', function (Y) {
* @method renderFile
* @param {Function} cb The callback fired when complete
* @param {String} cb.html The HTML to render this view
* @param {Object} cv.view The View Data
* @param {Object} cb.view The View Data
*/
renderFile: function (cb, data, layout) {
var self = this;
Expand Down Expand Up @@ -1566,6 +1574,7 @@ YUI.add('doc-builder', function (Y) {
* Render the API meta and return the JavaScript
* @method renderAPIMeta
* @param {Callback} cb The callback
* @param {String} cb.apijs The JavaScript code to write API meta data
* @async
*/
renderAPIMeta: function (cb) {
Expand Down