# attachModuleSymbols(doclets, modules)
private method
Look for classes or functions with the same name as modules (which indicates that the module exports only that class or function), then attach the classes or functions to the module property of the appropriate module doclets. The name of each class or function is also updated for display purposes. This function mutates the original arrays.
Parameters
| Name | Types | Description |
|---|---|---|
| doclets | Array.<module:jsdoc/doclet.Doclet> |
- The array of classes and functions to check. |
| modules | Array.<module:jsdoc/doclet.Doclet> |
- The array of module doclets to search. |
# buildNav(members, members.classes, members.externals, members.globals, members.mixins, members.modules, members.namespaces, members.tutorials, members.events, members.interfaces)
Create the navigation sidebar.
Parameters
| Name | Types | Description |
|---|---|---|
| members | object |
The members that will be used to create the sidebar. |
| members.classes | array<object> |
|
| members.externals | array<object> |
|
| members.globals | array<object> |
|
| members.mixins | array<object> |
|
| members.modules | array<object> |
|
| members.namespaces | array<object> |
|
| members.tutorials | array<object> |
|
| members.events | array<object> |
|
| members.interfaces | array<object> |
Returns
string
The HTML for the navigation sidebar.
# exports.publish(taffyData, opts, tutorials)
Parameters
| Name | Types | Description |
|---|---|---|
| taffyData | TAFFY |
See http://taffydb.com/. |
| opts | object |
|
| tutorials | Tutorial |
# exports.add(n1, n2)
Add two numbers
Parameters
| Name | Types | Description |
|---|---|---|
| n1 | number |
- First number |
| n2 | number |
- Second number |
# exports.divide(n1, n2)
Divide two numbers
Parameters
| Name | Types | Description |
|---|---|---|
| n1 | number |
- First number |
| n2 | number |
- Second number |
# exports.multiply(n1, n2)
Multiply two numbers
Parameters
| Name | Types | Description |
|---|---|---|
| n1 | number |
- First number |
| n2 | number |
- Second number |
# exports.subtract(n1, n2)
Subtract two numbers
Parameters
| Name | Types | Description |
|---|---|---|
| n1 | number |
- First number |
| n2 | number |
- Second number |
# calculateTax(amount, tax)
Calculate tax
Parameters
| Name | Types | Description |
|---|---|---|
| amount | number |
- Total amount |
| tax | number |
- Tax percentage |
# constructor(personInfo)
Parameters
| Name | Types | Description |
|---|---|---|
| personInfo | Object |
Information about the person |