Skip to content

doc: link and style parameter types #4741

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

doc: link and style parameter types #4741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58b5af2
tools: parse types into links in doc html gen
claudiorodriguez Jan 19, 2016
d269f8e
doc: fix type references for link gen, link css
claudiorodriguez Jan 19, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/api/buffer.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -473,7 +473,7 @@ console.log(buf1.equals(buf3));

### buf.fill(value[, offset[, end]])

* `value` {String or Number}
* `value` {String|Number}
* `offset` {Number} Default: 0
* `end` {Number} Default: `buffer.length`
* Return: {Buffer}
Expand All @@ -490,7 +490,7 @@ console.log(b.toString());

### buf.indexOf(value[, byteOffset][, encoding])

* `value` {String, Buffer or Number}
* `value` {String|Buffer|Number}
* `byteOffset` {Number} Default: 0
* `encoding` {String} Default: `'utf8'`
* Return: {Number}
Expand Down Expand Up @@ -527,7 +527,7 @@ utf16Buffer.indexOf('\u03a3', -4, 'ucs2');

### buf.includes(value[, byteOffset][, encoding])

* `value` {String, Buffer or Number}
* `value` {String|Buffer|Number}
* `byteOffset` {Number} Default: 0
* `encoding` {String} Default: `'utf8'`
* Return: {Boolean}
Expand Down
24 changes: 12 additions & 12 deletions doc/api/child_process.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ exec('my.bat', (err, stdout, stderr) => {
* `error` {Error}
* `stdout` {Buffer}
* `stderr` {Buffer}
* Return: ChildProcess object
* Return: {ChildProcess}

Spawns a shell then executes the `command` within that shell, buffering any
generated output.
Expand Down Expand Up @@ -200,7 +200,7 @@ replace the existing process and uses a shell to execute the command.*
* `error` {Error}
* `stdout` {Buffer}
* `stderr` {Buffer}
* Return: ChildProcess object
* Return: {ChildProcess}

The `child_process.execFile()` function is similar to [`child_process.exec()`][]
except that it does not spawn a shell. Rather, the specified executable `file`
Expand Down Expand Up @@ -236,7 +236,7 @@ const child = execFile('node', ['--version'], (error, stdout, stderr) => {
[`stdio`][] for more details (default is false)
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
* Return: ChildProcess object
* Return: {ChildProcess}

The `child_process.fork()` method is a special case of
[`child_process.spawn()`][] used specifically to spawn new Node.js processes.
Expand Down Expand Up @@ -282,7 +282,7 @@ not clone the current process.*
'/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be
specified as a string. The shell should understand the `-c` switch on UNIX,
or `/s /c` on Windows. Defaults to `false` (no shell).
* return: {ChildProcess object}
* return: {ChildProcess}

The `child_process.spawn()` method spawns a new process using the given
`command`, with command line arguments in `args`. If omitted, `args` defaults
Expand Down Expand Up @@ -635,7 +635,7 @@ disconnecting it is no longer possible to send or receive messages, and the

### Event: 'error'

* `err` {Error Object} the error.
* `err` {Error} the error.

The `'error'` event is emitted whenever:

Expand Down Expand Up @@ -672,7 +672,7 @@ See `waitpid(2)`.
### Event: 'message'

* `message` {Object} a parsed JSON object or primitive value.
* `sendHandle` {Handle object} a [`net.Socket`][] or [`net.Server`][] object, or
* `sendHandle` {Handle} a [`net.Socket`][] or [`net.Server`][] object, or
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link does not appear to work.

undefined.

The `'message'` event is triggered when a child process uses `process.send()`
Expand Down Expand Up @@ -736,7 +736,7 @@ See `kill(2)`

### child.pid

* {Integer}
* {Number} Integer

Returns the process identifier (PID) of the child process.

Expand All @@ -753,9 +753,9 @@ grep.stdin.end();
### child.send(message[, sendHandle][, callback])

* `message` {Object}
* `sendHandle` {Handle object}
* `sendHandle` {Handle}
* `callback` {Function}
* Return: Boolean
* Return: {Boolean}

When an IPC channel has been established between the parent and child (
i.e. when using [`child_process.fork()`][]), the `child.send()` method can be
Expand Down Expand Up @@ -895,7 +895,7 @@ this occurs.

### child.stderr

* {Stream object}
* {Stream}

A `Readable Stream` that represents the child process's `stderr`.

Expand All @@ -907,7 +907,7 @@ the same value.

### child.stdin

* {Stream object}
* {Stream}

A `Writable Stream` that represents the child process's `stdin`.

Expand Down Expand Up @@ -959,7 +959,7 @@ assert.equal(child.stdio[2], child.stderr);

### child.stdout

* {Stream object}
* {Stream}

A `Readable Stream` that represents the child process's `stdout`.

Expand Down
18 changes: 9 additions & 9 deletions doc/api/cluster.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ it is [`kill`][].

### worker.process

* {ChildProcess object}
* {ChildProcess}

All workers are created using [`child_process.fork()`][], the returned object
from this function is stored as `.process`. In a worker, the global `process`
Expand All @@ -346,7 +346,7 @@ disconnection.
### worker.send(message[, sendHandle][, callback])

* `message` {Object}
* `sendHandle` {Handle object}
* `sendHandle` {Handle}
* `callback` {Function}
* Return: Boolean

Expand Down Expand Up @@ -394,7 +394,7 @@ worker.kill();

## Event: 'disconnect'

* `worker` {Worker object}
* `worker` {cluster.Worker}

Emitted after the worker IPC channel has disconnected. This can occur when a
worker exits gracefully, is killed, or is disconnected manually (such as with
Expand All @@ -412,7 +412,7 @@ cluster.on('disconnect', (worker) => {

## Event: 'exit'

* `worker` {Worker object}
* `worker` {cluster.Worker}
* `code` {Number} the exit code, if it exited normally.
* `signal` {String} the name of the signal (eg. `'SIGHUP'`) that caused
the process to be killed.
Expand All @@ -433,7 +433,7 @@ See [child_process event: 'exit'][].

## Event: 'fork'

* `worker` {Worker object}
* `worker` {cluster.Worker}

When a new worker is forked the cluster module will emit a `'fork'` event.
This can be used to log worker activity, and create your own timeout.
Expand All @@ -458,7 +458,7 @@ cluster.on('exit', (worker, code, signal) => {

## Event: 'listening'

* `worker` {Worker object}
* `worker` {cluster.Worker}
* `address` {Object}

After calling `listen()` from a worker, when the `'listening'` event is emitted on
Expand All @@ -485,7 +485,7 @@ The `addressType` is one of:

## Event: 'message'

* `worker` {Worker object}
* `worker` {cluster.Worker}
* `message` {Object}

Emitted when any worker receives a message.
Expand All @@ -494,7 +494,7 @@ See [child_process event: 'message'][].

## Event: 'online'

* `worker` {Worker object}
* `worker` {cluster.Worker}

After forking a new worker, the worker should respond with an online message.
When the master receives an online message it will emit this event.
Expand Down Expand Up @@ -536,7 +536,7 @@ This can only be called from the master process.
## cluster.fork([env])

* `env` {Object} Key/value pairs to add to worker process environment.
* return {Worker object}
* return {cluster.Worker}

Spawn a new worker process.

Expand Down
34 changes: 17 additions & 17 deletions doc/api/crypto.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -722,8 +722,8 @@ The `private_key` argument can be an object or a string. If `private_key` is a
string, it is treated as a raw key with no passphrase. If `private_key` is an
object, it is interpreted as a hash containing two properties:

* `key` : A string holding the PEM encoded private key
* `passphrase` : A string of passphrase for the private key
* `key` : {String} - PEM encoded private key
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other places didn't have colons.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, it would be better if the type and description seperator is consistent in all the files.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thefourtheye I agree, but unfortunately everything was already inconsistent. I think refactoring that belongs to another PR IMHO

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, there are quite a few areas here where incremental improvements need to be made. We'll get there but breaking it up into smaller incremental changes is likely best

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jasnell Yup, I completely agree. That would be much easier to review as well :)

* `passphrase` : {String} - passphrase for the private key

The `output_format` can specify one of `'binary'`, `'hex'` or `'base64'`. If
`output_format` is provided a string is returned; otherwise a [`Buffer`][] is
Expand Down Expand Up @@ -862,16 +862,16 @@ method should not be used.

The optional `details` argument is a hash object with keys:

* `pfx` : A string or [`Buffer`][] holding the PFX or PKCS12 encoded private
* `pfx` : {String|Buffer} - PFX or PKCS12 encoded private
key, certificate and CA certificates
* `key` : A string holding the PEM encoded private key
* `passphrase` : The string passphrase for the private key or PFX
* `cert` : A string holding the PEM encoded certificate
* `ca` : Either a string or array of strings of PEM encoded CA
* `key` : {String} - PEM encoded private key
* `passphrase` : {String} - passphrase for the private key or PFX
* `cert` : {String} - PEM encoded certificate
* `ca` : {String|Array} - Either a string or array of strings of PEM encoded CA
certificates to trust.
* `crl` : Either a string or array of strings of PEM encoded CRLs
* `crl` : {String|Array} - Either a string or array of strings of PEM encoded CRLs
(Certificate Revocation List)
* `ciphers`: A string using the [OpenSSL cipher list format][] describing the
* `ciphers`: {String} using the [OpenSSL cipher list format][] describing the
cipher algorithms to use or exclude.

If no 'ca' details are given, Node.js will use Mozilla's default
Expand Down Expand Up @@ -1144,8 +1144,8 @@ treated as the key with no passphrase and will use `RSA_PKCS1_OAEP_PADDING`.
If `private_key` is an object, it is interpreted as a hash object with the
keys:

* `key` : A string holding the PEM encoded private key
* `passphrase` : An optional string of passphrase for the private key
* `key` : {String} - PEM encoded private key
* `passphrase` : {String} - Optional passphrase for the private key
* `padding` : An optional padding value, one of the following:
* `constants.RSA_NO_PADDING`
* `constants.RSA_PKCS1_PADDING`
Expand All @@ -1162,8 +1162,8 @@ treated as the key with no passphrase and will use `RSA_PKCS1_PADDING`.
If `private_key` is an object, it is interpreted as a hash object with the
keys:

* `key` : A string holding the PEM encoded private key
* `passphrase` : An optional string of passphrase for the private key
* `key` : {String} - PEM encoded private key
* `passphrase` : {String} - Optional passphrase for the private key
* `padding` : An optional padding value, one of the following:
* `constants.RSA_NO_PADDING`
* `constants.RSA_PKCS1_PADDING`
Expand All @@ -1180,8 +1180,8 @@ treated as the key with no passphrase and will use `RSA_PKCS1_PADDING`.
If `public_key` is an object, it is interpreted as a hash object with the
keys:

* `key` : A string holding the PEM encoded public key
* `passphrase` : An optional string of passphrase for the private key
* `key` : {String} - PEM encoded public key
* `passphrase` : {String} - Optional passphrase for the private key
* `padding` : An optional padding value, one of the following:
* `constants.RSA_NO_PADDING`
* `constants.RSA_PKCS1_PADDING`
Expand All @@ -1201,8 +1201,8 @@ treated as the key with no passphrase and will use `RSA_PKCS1_OAEP_PADDING`.
If `public_key` is an object, it is interpreted as a hash object with the
keys:

* `key` : A string holding the PEM encoded public key
* `passphrase` : An optional string of passphrase for the private key
* `key` : {String} - PEM encoded public key
* `passphrase` : {String} - Optional passphrase for the private key
* `padding` : An optional padding value, one of the following:
* `constants.RSA_NO_PADDING`
* `constants.RSA_PKCS1_PADDING`
Expand Down
Loading