Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/tj/dox
/ functions
Functions
62 in github.com/tj/dox
⨍
Functions
62
◇
Types & classes
8
↓ 32 callers
Function
fixture
(name, fn)
test/dox.test.js:10
↓ 3 callers
Function
escape
* Escape the given `html`. * * @param {String} html * @return {String} * @api private * @custom With `Markdown` syntax
test/fixtures/c.js:262
↓ 2 callers
Function
params
(tags)
lib/api.js:74
↓ 1 callers
Function
context
(comment)
lib/api.js:54
↓ 1 callers
Function
fixture
(name, fn)
test/dox.jsdoccomplex.test.js:9
↓ 1 callers
Function
fixture
(name, fn)
test/dox.multilinetags.test.js:9
↓ 1 callers
Function
headings
(str)
lib/api.js:44
↓ 1 callers
Function
slug
(str)
lib/api.js:40
↓ 1 callers
Function
toc
(str)
lib/api.js:33
Function
Foo
* Does a lot of foo * * @constructor * @param {String} bar
test/fixtures/prototypes.js:8
Function
Foo
* Luke, I am your constructor. * * @param {Array} bar * @constructor
test/fixtures/prototypes-inline.js:9
Function
NAME
(nameNode)
lib/dox.js:413
Method
[Symbol.iterator]
* Generator method with computed name. * @return {String}
test/fixtures/classes.js:46
Method
bar
()
test/fixtures/classes.js:22
Method
blah
()
test/fixtures/classes.js:53
Function
breakingBad
* My only purpose is to check we do not inherit from any parent context. * * @returns {string}
test/fixtures/prototypes-inline.js:61
Function
complexTypeParamAndReturn
* * @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
Method
constructor
(options)
test/fixtures/classes.js:14
Method
constructor
(options)
test/fixtures/classes.js:75
Method
constructor
(options)
test/fixtures/classes.js:84
Method
constructor
(options)
test/fixtures/classes.js:93
Function
crashMe
* Raise an exception for fun. * * @throws An error message.
test/fixtures/throws.js:6
Function
eight
* Eight
test/fixtures/string-quotes.js:54
Function
example
* example * * @example * test(one); * test(two);
test/fixtures/multilinetags.js:152
Function
first
* first * * @sample * one * two * three * @bar last
test/fixtures/multilinetags.js:21
Function
first
* 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
Function
firstParam
* first * * @param {String} foo * one * two * three * @bar last
test/fixtures/multilinetags.js:69
Function
firstReturn
* first * * @return {String} * one * two * three * @bar last
test/fixtures/multilinetags.js:117
Function
five
* Five
test/fixtures/string-quotes.js:32
Function
fnName
* Function Name * * @param {String} a * @param {Number} b
test/fixtures/functions.js:7
Function
foo
* Code below must contain the useful comment
test/fixtures/singleline.js:4
Function
foo
()
test/fixtures/uncommented.js:1
Function
foo
()
test/fixtures/single.js:6
Function
foo
* @return {number} Digit
test/fixtures/nodescription.js:4
Function
four
* Four
test/fixtures/string-quotes.js:25
Function
four
(num)
test/fixtures/asterik.js:27
Function
last
* last * * @foo first * @sample * one * two * three
test/fixtures/multilinetags.js:33
Function
lastParam
* last * * @foo first * @param {String} foo * one * two * three
test/fixtures/multilinetags.js:81
Function
lastReturn
* last * * @foo first * @return {String} * one * two * three
test/fixtures/multilinetags.js:129
Function
mid
* mid * * @foo first * @sample * one * two * three * @bar last
test/fixtures/multilinetags.js:46
Function
midParam
* mid * * @foo first * @param {String} foo * one * two * three * @bar last
test/fixtures/multilinetags.js:94
Function
midReturn
* mid * * @foo first * @return {String} * one * two * three * @bar last
test/fixtures/multilinetags.js:142
Function
nestedComplexTypeParam
* * @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
Function
nonNullableParam
* * @param {!number} a
test/fixtures/jsdoc-complex-types.js:42
Function
nullableParam
* * @param {?number} a
test/fixtures/jsdoc-complex-types.js:34
Function
one
* One
test/fixtures/string-quotes.js:4
Function
one
()
test/fixtures/asterik.js:4
Function
only
* only * * @sample * one * two * three
test/fixtures/multilinetags.js:9
Function
onlyParam
* only * * @param {String} foo * one * two * three
test/fixtures/multilinetags.js:57
Function
onlyReturn
* only * * @return {String} * one * two * three
test/fixtures/multilinetags.js:105
Function
optionalParam
* * @param {number=} a
test/fixtures/jsdoc-complex-types.js:26
Function
seed
* Sets an internal property. * * @param {Number} s
test/fixtures/prototypes-inline.js:43
Function
seven
* Seven
test/fixtures/string-quotes.js:46
Function
six
* Six
test/fixtures/string-quotes.js:39
Method
staticGeneratorMethod
* Static generator method of the Foo class. * @return {String}
test/fixtures/classes.js:38
Method
staticMethod
* Static method of the Foo class. * @return {String}
test/fixtures/classes.js:30
Function
three
* Three
test/fixtures/string-quotes.js:18
Function
three
()
test/fixtures/asterik.js:19
Function
two
* Two
test/fixtures/string-quotes.js:11
Function
two
(num)
test/fixtures/asterik.js:12
Function
validateUserInput
* Validate user input. * * @throws {TypeError} Invalid argument.
test/fixtures/throws.js:15
Function
variableParam
* * @param {...number} a
test/fixtures/jsdoc-complex-types.js:50