JSDoc

Global

Global scope

Members

bar :number

Source:
tags/type.js, line 4
Type:

number

FOO :number

A constant.
Source:
tags/readonly.js, line 6
Type:

number

foo :string|Array.<number>

Source:
tags/type.js, line 2
Type:

string or number[]

FOO :number

Source:
tags/type.js, line 8
Type:

number

foo :number

Source:
tags/type.js, line 12
Type:

number

foo :Object.<string, number>

Source:
tags/type.js, line 16
Type:

Object.<string, number>

myModule

This will show up as a constant
Source:
tags/kind.js, line 1

ONE :number

Source:
tags/constant.js, line 8
Type:

number

RED :string

Default Value:
FF0000
Source:
tags/constant.js, line 5
Type:

string

RED

Default Value:
16711680
Source:
tags/default.js, line 5

triState :number

Enum for tri-state values.
Source:
tags/enum.js, line 6
Properties:
Name Type Description
TRUE
number The true value
FALSE
number
MAYBE
boolean
Type:

number

Methods

add(a, b) → {number}

Add two numbers.
Source:
tags/description.js, line 7
Parameters:
Name Type Description
a
number
b
number
Returns:
Type
number

bar()

Source:
tags/see.js, line 13
See:
foo for further information.
GitHub

bar()

Source:
tags/throws.js, line 8
Throws:
Will throw an error if the argument is null.

baz()

Source:
tags/throws.js, line 12
Throws:
Argument x must be non-zero.
Type
DivideByZero

bloviate()

A concise summary.

A very long, verbose, wordy, long-winded, tedious, verbacious, tautological, profuse, expansive, enthusiastic, redundant, flowery, eloquent, articulate, loquacious, garrulous, chatty, extended, babbling description.
Source:
tags/summary.js, line 7

doSomethingAsynchronously(cb)

Does something asynchronously and executes the callback on completion.
Source:
tags/param.js, line 119
Parameters:
Name Type Description
cb
requestCallback The callback that handles the response.

downloadData(url) → {Promise.<string>}

Download data from the specified URL.
Source:
tags/async.js, line 1
Parameters:
Name Type Description
url
string The URL to download from.
Returns:
The data from the URL.
Type
Promise.<string>

fibonacci() → {number}

Generate numbers in the Fibonacci sequence.
Source:
tags/generator.js, line 1
Yields:
The next number in the Fibonacci sequence.
Type
number

fibonacci() → {number}

Generate the Fibonacci sequence of numbers.
Source:
tags/yields.js, line 6
Yields:
Type
number

fibonacci1() → {number}

Generate the Fibonacci sequence of numbers.
Source:
tags/yields.js, line 13
Yields:
The next number in the Fibonacci sequence.
Type
number

foo()

Both of these will link to the bar function.
Source:
tags/see.js, line 6
See:
bar
bar

foo()

Source:
tags/throws.js, line 4
Throws:
InvalidArgumentException

foo()

Source:
tags/todo.js, line 5
To Do:
Write the documentation.
Implement this function.

fooFactory()

Generates BaseObject instances.
Source:
tags/instance.js, line 11

highlightSearchTerm(term)

Source:
tags/name.js, line 1
Parameters:
Name Type Description
term
string The search term to highlight.

myFunction()

See MyClass and MyClass's foo property. Also, check out Google and GitHub.
Source:
tags/link.js, line 6

myFunction()

See gettingstarted and dashboard. For more information, see create|Creating a Widget and destroy Destroying a Widget.
Source:
tags/tutorial.js, line 14

old()

Deprecated:
since version 2.0
Source:
tags/deprecated.js, line 4

sayHello1(somebody)

Source:
tags/param.js, line 4
Parameters:
Name Type Description
somebody

sayHello2(somebody)

Source:
tags/param.js, line 10
Parameters:
Name Type Description
somebody
string

sayHello3(somebody)

Source:
tags/param.js, line 16
Parameters:
Name Type Description
somebody
string Somebody's name.

sayHello4(somebody)

Source:
tags/param.js, line 22
Parameters:
Name Type Description
somebody
string Somebody's name.

sayHello5(somebodyopt)

Source:
tags/param.js, line 55
Parameters:
Name Type Description
somebody
[optional] 		string Somebody's name.

sayHello6(somebodyopt)

Source:
tags/param.js, line 64
Parameters:
Name Type Description
somebody
[optional] 		string Somebody's name.

sayHello7(somebodyopt)

Source:
tags/param.js, line 73
Parameters:
Name Type Default Description
somebody
[optional] 		string John Doe Somebody's name.

sayHello8(somebodyopt)

Source:
tags/param.js, line 82
Parameters:
Name Type Default Description
somebody
[optional] 		string or string[] John Doe Somebody's name, or an array of names.

sayHello9(somebody)

Source:
tags/param.js, line 93
Parameters:
Name Type Description
somebody
Any Whatever you want.

setMagicNumber(x)

Set the magic number.
Source:
tags/typedef.js, line 10
Parameters:
Name Type Description
x
NumberLike The magic number.

setName()

Source:
tags/this.js, line 7
This:

Greeter

solver()

Solves equations of the form a * x = b. Returns the value of x.
Version:
1.2.3
Source:
tags/version.js, line 7
Tutorials:
Tutorial: solver

sum(...num)

Returns the sum of all numbers passed to the function.
Source:
tags/param.js, line 100
Parameters:
Name Type Description
num
[repeatable] 		number A positive or negative number.

sum1(a, b) → {number}

Returns the sum of a and b
Source:
tags/returns.js, line 7
Parameters:
Name Type Description
a
number
b
number
Returns:
Type
number

sum2(a, b) → {number}

Returns the sum of a and b
Source:
tags/returns.js, line 16
Parameters:
Name Type Description
a
number
b
number
Returns:
Sum of a and b
Type
number

sum3(a, b, retArr) → {number|Array}

Returns the sum of a and b
Source:
tags/returns.js, line 26
Parameters:
Name Type Description
a
number
b
number
retArr
boolean If set to true, the function will return an array
Returns:
Sum of a and b or an array that contains a, b and the sum of a and b.
Type
number or Array

sumAsync(a, b) → {Promise}

Returns the sum of a and b
Source:
tags/returns.js, line 38
Parameters:
Name Type Description
a
number
b
number
Returns:
Promise object represents the sum of a and b
Type
Promise

trstr(str)

Remove whitespace from around a string.
Source:
tags/borrows.js, line 13
Parameters:
Name Type Description
str
string

UserRecord()

Provides access to user information.
Since:
1.0.1
Source:
tags/since.js, line 5

Type Definitions

NumberLike

A number, or a string containing a number.
Source:
tags/typedef.js, line 1
Type:

number or string

requestCallback(responseCode, responseMessage)

This callback type is called `requestCallback` and is displayed as a global symbol.
Source:
tags/param.js, line 107
Parameters:
Name Type Description
responseCode
number
responseMessage
string

User

User type definition
Source:
tags/property.js, line 18
Properties:
Name Type Description
email
string
nickName
[optional] 		string
Type:

Object

THIS IS A DEMO: All content was generated with examples taken from the JSDoc page.