MCPcopy Create free account

hub / github.com/tj/dox / functions

Functions62 in github.com/tj/dox

↓ 32 callersFunctionfixture
(name, fn)
test/dox.test.js:10
↓ 3 callersFunctionescape
* Escape the given `html`. * * @param {String} html * @return {String} * @api private * @custom With `Markdown` syntax
test/fixtures/c.js:262
↓ 2 callersFunctionparams
(tags)
lib/api.js:74
↓ 1 callersFunctioncontext
(comment)
lib/api.js:54
↓ 1 callersFunctionfixture
(name, fn)
test/dox.jsdoccomplex.test.js:9
↓ 1 callersFunctionfixture
(name, fn)
test/dox.multilinetags.test.js:9
↓ 1 callersFunctionheadings
(str)
lib/api.js:44
↓ 1 callersFunctionslug
(str)
lib/api.js:40
↓ 1 callersFunctiontoc
(str)
lib/api.js:33
FunctionFoo
* Does a lot of foo * * @constructor * @param {String} bar
test/fixtures/prototypes.js:8
FunctionFoo
* Luke, I am your constructor. * * @param {Array} bar * @constructor
test/fixtures/prototypes-inline.js:9
FunctionNAME
(nameNode)
lib/dox.js:413
Method[Symbol.iterator]
* Generator method with computed name. * @return {String}
test/fixtures/classes.js:46
Methodbar
()
test/fixtures/classes.js:22
Methodblah
()
test/fixtures/classes.js:53
FunctionbreakingBad
* My only purpose is to check we do not inherit from any parent context. * * @returns {string}
test/fixtures/prototypes-inline.js:61
FunctioncomplexTypeParamAndReturn
* * @param {number|string|{name:string,age:number}} a * @param {number|{name:string,age:number}|Array} a * @returns {{name:string,age:number}}
test/fixtures/jsdoc-complex-types.js:7
Methodconstructor
(options)
test/fixtures/classes.js:14
Methodconstructor
(options)
test/fixtures/classes.js:75
Methodconstructor
(options)
test/fixtures/classes.js:84
Methodconstructor
(options)
test/fixtures/classes.js:93
FunctioncrashMe
* Raise an exception for fun. * * @throws An error message.
test/fixtures/throws.js:6
Functioneight
* Eight
test/fixtures/string-quotes.js:54
Functionexample
* example * * @example * test(one); * test(two);
test/fixtures/multilinetags.js:152
Functionfirst
* first * * @sample * one * two * three * @bar last
test/fixtures/multilinetags.js:21
Functionfirst
* Returns the first item. * Acts as an ES5 alias of `Foo.prototype.getFirst` for feature sake. * * @see Foo.prototype.getFirst * @returns
test/fixtures/prototypes-inline.js:35
FunctionfirstParam
* first * * @param {String} foo * one * two * three * @bar last
test/fixtures/multilinetags.js:69
FunctionfirstReturn
* first * * @return {String} * one * two * three * @bar last
test/fixtures/multilinetags.js:117
Functionfive
* Five
test/fixtures/string-quotes.js:32
FunctionfnName
* Function Name * * @param {String} a * @param {Number} b
test/fixtures/functions.js:7
Functionfoo
* Code below must contain the useful comment
test/fixtures/singleline.js:4
Functionfoo
()
test/fixtures/uncommented.js:1
Functionfoo
()
test/fixtures/single.js:6
Functionfoo
* @return {number} Digit
test/fixtures/nodescription.js:4
Functionfour
* Four
test/fixtures/string-quotes.js:25
Functionfour
(num)
test/fixtures/asterik.js:27
Functionlast
* last * * @foo first * @sample * one * two * three
test/fixtures/multilinetags.js:33
FunctionlastParam
* last * * @foo first * @param {String} foo * one * two * three
test/fixtures/multilinetags.js:81
FunctionlastReturn
* last * * @foo first * @return {String} * one * two * three
test/fixtures/multilinetags.js:129
Functionmid
* mid * * @foo first * @sample * one * two * three * @bar last
test/fixtures/multilinetags.js:46
FunctionmidParam
* mid * * @foo first * @param {String} foo * one * two * three * @bar last
test/fixtures/multilinetags.js:94
FunctionmidReturn
* mid * * @foo first * @return {String} * one * two * three * @bar last
test/fixtures/multilinetags.js:142
FunctionnestedComplexTypeParam
* * @param {number | string | {length: number, type: {name: {first: string, last: string}, id: number | string}}} a Description of param
test/fixtures/jsdoc-complex-types.js:18
FunctionnonNullableParam
* * @param {!number} a
test/fixtures/jsdoc-complex-types.js:42
FunctionnullableParam
* * @param {?number} a
test/fixtures/jsdoc-complex-types.js:34
Functionone
* One
test/fixtures/string-quotes.js:4
Functionone
()
test/fixtures/asterik.js:4
Functiononly
* only * * @sample * one * two * three
test/fixtures/multilinetags.js:9
FunctiononlyParam
* only * * @param {String} foo * one * two * three
test/fixtures/multilinetags.js:57
FunctiononlyReturn
* only * * @return {String} * one * two * three
test/fixtures/multilinetags.js:105
FunctionoptionalParam
* * @param {number=} a
test/fixtures/jsdoc-complex-types.js:26
Functionseed
* Sets an internal property. * * @param {Number} s
test/fixtures/prototypes-inline.js:43
Functionseven
* Seven
test/fixtures/string-quotes.js:46
Functionsix
* Six
test/fixtures/string-quotes.js:39
MethodstaticGeneratorMethod
* Static generator method of the Foo class. * @return {String}
test/fixtures/classes.js:38
MethodstaticMethod
* Static method of the Foo class. * @return {String}
test/fixtures/classes.js:30
Functionthree
* Three
test/fixtures/string-quotes.js:18
Functionthree
()
test/fixtures/asterik.js:19
Functiontwo
* Two
test/fixtures/string-quotes.js:11
Functiontwo
(num)
test/fixtures/asterik.js:12
FunctionvalidateUserInput
* Validate user input. * * @throws {TypeError} Invalid argument.
test/fixtures/throws.js:15
FunctionvariableParam
* * @param {...number} a
test/fixtures/jsdoc-complex-types.js:50