nodejs

mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00

History

Vse Mozhet Byt 89425817d0 doc: support multidimensional arrays in type link Currently, we have at least one multidimensional array in type signature: see `records` parameter in https://nodejs.org/api/dns.html#dns_dns_resolvetxt_hostname_callback Our type parser does not linkify these signatures properly. This PR tries to fix this. PR-URL: https://github.com/nodejs/node/pull/16207 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>		2017-10-15 21:53:07 -07:00
..
node_modules
addon-verify.js	tools: fix tools/addon-verify.js	2017-08-10 07:24:30 +02:00
common.js
generate.js	tools: use template literal in error message	2017-10-13 13:59:43 -07:00
html.js	tools: use template literals	2017-10-08 15:17:56 -07:00
json.js	tools: replace concat with template literals	2017-10-09 02:13:21 -07:00
LICENSE
package.json	tools: update package.json `engine` field	2017-07-14 13:49:22 -07:00
preprocess.js
README.md
type-parser.js	doc: support multidimensional arrays in type link	2017-10-15 21:53:07 -07: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)