nodejs

mirror of https://github.com/nodejs/node.git synced 2024-11-30 23:43:09 +01:00

History

James M Snell 0c712b6743 tools: add mdn link for Iterator PR-URL: https://github.com/nodejs/node/pull/10620 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Michal Zasso <targos@protonmail.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com>		2017-01-23 09:57:36 -08:00
..
node_modules
addon-verify.js
common.js
generate.js	tools: remove unneeded escaping in generate.js	2016-11-27 10:23:31 -08:00
html.js	lib,tools: remove unneeded escaping of /	2016-11-23 22:06:24 -08:00
json.js	tools: refactor json.js	2016-12-28 22:34:42 -08:00
LICENSE
package.json
preprocess.js
README.md	doc: remove duplicate properties bullet in readme	2017-01-13 09:53:53 -08:00
type-parser.js	tools: add mdn link for Iterator	2017-01-23 09:57:36 -08:00

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)