nodejs

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

History

Anna Henningsen 048b3de22d doc: fix broken references Fix minor broken references in crypto.md, net.md and domains.md (which uses `EventEmitter` as a type, of which the anchor in `events.md` has changed). PR-URL: https://github.com/nodejs/node/pull/6941 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>		2016-05-26 00:52:36 +02:00
..
node_modules	tools: update marked dependency	2016-05-07 09:27:05 +02:00
addon-verify.js	tools: fix tools/doc/addon-verify.js regression	2016-05-10 17:12:01 +02:00
common.js	tools: allow multiple added: version entries	2016-05-05 01:15:10 +02:00
generate.js	tools: restore change of signatures to opts hashes	2016-05-25 22:44:57 +02:00
html.js	tools: make sure doctool anchors respect includes	2016-05-26 00:49:34 +02:00
json.js	tools: update marked dependency	2016-05-07 09:27:05 +02:00
LICENSE
package.json	tools: update marked dependency	2016-05-07 09:27:05 +02:00
preprocess.js	tools: make sure doctool anchors respect includes	2016-05-26 00:49:34 +02:00
README.md	tools: parse documentation metadata	2016-05-05 01:15:10 +02:00
type-parser.js	doc: fix broken references	2016-05-26 00:52:36 +02: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.

### 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.

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)