76 lines
1.8 KiB
Markdown
76 lines
1.8 KiB
Markdown
|
Here's how the node docs work.
|
||
|
|
|
||
|
|
Each type of heading has a description block.
|
||
|
|
|
||
|
|
|
||
|
|
## module
|
||
|
|
|
||
|
|
Stability: 3 - Stable
|
||
|
|
|
||
|
|
description and examples.
|
||
|
|
|
||
|
|
### module.property
|
||
|
|
|
||
|
|
* Type
|
||
|
|
|
||
|
|
description of the property.
|
||
|
|
|
||
|
|
### module.someFunction(x, y, [z=100])
|
||
|
|
|
||
|
|
* `x` {String} the description of the string
|
||
|
|
* `y` {Boolean} Should I stay or should I go?
|
||
|
|
* `z` {Number} How many zebras to bring.
|
||
|
|
|
||
|
|
A description of the function.
|
||
|
|
|
||
|
|
### Event: 'blerg'
|
||
|
|
|
||
|
|
* Argument: SomeClass object.
|
||
|
|
|
||
|
|
Modules don't usually raise events on themselves. `cluster` is the
|
||
|
|
only exception.
|
||
|
|
|
||
|
|
## Class: SomeClass
|
||
|
|
|
||
|
|
description of the class.
|
||
|
|
|
||
|
|
### Class Method: SomeClass.classMethod(anArg)
|
||
|
|
|
||
|
|
* `anArg` {Object} Just an argument
|
||
|
|
* `field` {String} anArg can have this field.
|
||
|
|
* `field2` {Boolean} Another field. Default: `false`.
|
||
|
|
* Return: {Boolean} `true` if it worked.
|
||
|
|
|
||
|
|
Description of the method for humans.
|
||
|
|
|
||
|
|
### someClass.nextSibling()
|
||
|
|
|
||
|
|
* Return: {SomeClass object | null} The next someClass in line.
|
||
|
|
|
||
|
|
### someClass.someProperty
|
||
|
|
|
||
|
|
* String
|
||
|
|
|
||
|
|
The indication of what someProperty is.
|
||
|
|
|
||
|
|
### Event: 'grelb'
|
||
|
|
|
||
|
|
* `isBlerg` {Boolean}
|
||
|
|
|
||
|
|
This event is emitted on instances of SomeClass, not on the module itself.
|
||
|
|
|
||
|
|
|
||
|
|
* Modules have (description, Properties, Functions, Classes, Examples)
|
||
|
|
* Properties have (type, description)
|
||
|
|
* Functions have (list of arguments, description)
|
||
|
|
* Classes have (description, Properties, Methods, Events)
|
||
|
|
* Events have (list of arguments, description)
|
||
|
|
* Methods have (list of arguments, description)
|
||
|
|
* Properties have (type, description)
|
||
|
|
|
||
|
|
# CLI usage
|
||
|
|
|
||
|
|
Run the following from the etherpad-lite root directory:
|
||
|
|
```sh
|
||
|
|
$ node tools/doc/generate doc/index.md --format=html --template=doc/template.html > out.html
|
||
|
|
```
|