Created
March 20, 2012 11:16
-
-
Save davestewart/2134162 to your computer and use it in GitHub Desktop.
Suggestion for better documentation of multiple params
This file contains hidden or 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
// JSDoc multiple param format | |
/** | |
* Context object supplies the "this" context for all iterative operations' callbacks | |
* @param {Context|Boolean|Number|String|File|Document} dom A Context object with a valid dom property, or true to grab the current Document DOM, or the 0-based index of the Document, or the name of the Document, or a valid .fla File reference, or a Document instance | |
*/ | |
function Context(dom) | |
{ | |
} | |
// JSDoc multiple param format suggestion | |
/** | |
* Context object supplies the "this" context for all iterative operations' callbacks | |
* @param {Context} dom A Context object with a valid dom property | |
* @param {Boolean} dom Pass true to grab the current Document DOM | |
* @param {Number} dom The 0-based index of the Document | |
* @param {String} dom The name of the Document | |
* @param {File} dom A valid .fla File reference | |
* @param {Document} dom A Document instance | |
*/ | |
function Context(dom) | |
{ | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment