This is a simple exported function.
This is a function with multiple arguments and a return value.
This is a string parameter.
This is a parameter flagged with any. This sentence is placed in the next line.
This is a parameter pointing to an interface.
var value:BaseClass = new BaseClass('test');
functionWithArguments('arg', 0, value);
This is a function with a parameter that has a default value.
The input value or the default value.
See INameInterface
and INameInterface's name property.
Also, check out Google and
GitHub.
Taken from http://usejsdoc.org/tags-inline-link.html.
This is a function with a parameter that is optional.
A normal parameter.
An optional parameter.
This is a function with rest parameter.
Multiple strings.
The combined string.
This is a generic function.
The type parameter.
The typed value.
Returns the typed value.
This is an internal function.
This is the first signature of a function with multiple signatures.
The name value.
This is the second signature of a function with multiple signatures.
An object containing the name value.
A value of the object.
This is a function with multiple arguments and a return value.
This is a string parameter.
This is a parameter flagged with any. This sentence is placed in the next line.
This is a parameter pointing to an interface.
var value:BaseClass = new BaseClass('test');
functionWithArguments('arg', 0, value);
Generated using TypeDoc
A function that returns an object. Also no type information is given, the object should be correctly reflected.