ModuleClass
Class used to test jsdoc templating. This class will start very minimal and grow as various documenting use cases become apparent.
Class
ModuleClass(opts) Parameters
Name | Type | Description |
---|---|---|
opts | object | ModuleClass options. |
opts
Name | Type | Description |
---|---|---|
prop1 | string | A very import property. |
prop2 | string | A less important property. |
var module = new ModuleClass({
prop1: 'super duper important'
prop2: 'ehhh'
});
classMethod
A method that accepts some arguments and returns something.
Function
classMethod(str, arr, obj, callback) Parameters
Name | Type | Description |
---|---|---|
str | striing | A primitive string. |
arr | Array | An array of some numbers. |
obj | Object | Props and values yo. |
callback | function | Callback after you have done something sweet. |
Returns
Type | Description |
---|---|
string | A modified string. |
module.method('string', [0, 1], {
prop: 'value'
}, function () {});