You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Phillip Johnsen 01b90ee1db tools,doc: add Google Analytics tracking. 8 years ago
..
node_modules tools: update marked dependency 9 years ago
LICENSE Mention marked, and add license to doc generator 13 years ago
README.md doc: remove duplicate properties bullet in readme 8 years ago
addon-verify.js test: enable addons test to pass with debug build 8 years ago
common.js tools: allow multiple added: version entries 9 years ago
generate.js tools,doc: add Google Analytics tracking. 8 years ago
html.js tools,doc: add Google Analytics tracking. 8 years ago
json.js tools: refactor json.js 8 years ago
package.json tools: update marked dependency 9 years ago
preprocess.js tools: make sure doctool anchors respect includes 9 years ago
type-parser.js tools: add mdn link for Iterator 8 years ago

README.md

Here's how the node docs work.

1:1 relationship from lib/<module>.js to doc/api/<module>.md

Each type of heading has a description block.

## module
<!-- YAML
added: v0.10.0
-->

> Stability: 3 - Stable

description and examples.

### module.property
<!-- YAML
added: v0.10.0
-->

* Type

description of the property.

### module.someFunction(x, y, [z=100])
<!-- YAML
added: v0.10.0
-->

* `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.

### module.someNewFunction(x)
<!-- YAML
added: REPLACEME
-->

* `x` {String} the description of the string

This feature is not in a release yet.

### Event: 'blerg'
<!-- YAML
added: v0.10.0
-->

* Argument: SomeClass object.

Modules don't usually raise events on themselves.  `cluster` is the
only exception.

## Class: SomeClass
<!-- YAML
added: v0.10.0
-->

description of the class.

### Class Method: SomeClass.classMethod(anArg)
<!-- YAML
added: v0.10.0
-->

* `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()
<!-- YAML
added: v0.10.0
-->

* Return: {SomeClass object | null}  The next someClass in line.

### someClass.someProperty
<!-- YAML
added: v0.10.0
-->

* String

The indication of what someProperty is.

### Event: 'grelb'
<!-- YAML
added: v0.10.0
-->

* `isBlerg` {Boolean}

This event is emitted on instances of SomeClass, not on the module itself.
  • Classes have (description, Properties, Methods, Events)
  • Events have (list of arguments, description)
  • Functions have (list of arguments, description)
  • Methods have (list of arguments, description)
  • Modules have (description, Properties, Functions, Classes, Examples)
  • Properties have (type, description)