Skip to content

Commit 47e926a

Browse files
claudiorodriguezsilverwind
claudiorodriguez
authored and
silverwind
committed
doc: fix type references for link gen, link css
Fixes several type references in the docs so that the doc html gen tool that parses them can put the correct links in. Changes css styling for the generated type links. PR-URL: nodejs#4741 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Chris Dickinson <chris@neversaw.us> Reviewed-By: Roman Reiss <me@silverwind.io>
1 parent e517efa commit 47e926a

11 files changed

Lines changed: 104 additions & 100 deletions

‎doc/api/buffer.markdown‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,7 @@ console.log(buf1.equals(buf3));
473473

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

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

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

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

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

530-
* `value` {String, Buffer or Number}
530+
* `value` {String|Buffer|Number}
531531
* `byteOffset` {Number} Default: 0
532532
* `encoding` {String} Default: `'utf8'`
533533
* Return: {Boolean}

‎doc/api/child_process.markdown‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ exec('my.bat', (err, stdout, stderr) => {
133133
* `error` {Error}
134134
* `stdout` {Buffer}
135135
* `stderr` {Buffer}
136-
* Return: ChildProcess object
136+
* Return: {ChildProcess}
137137

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

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

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

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

636636
### Event: 'error'
637637

638-
* `err` {Error Object} the error.
638+
* `err` {Error} the error.
639639

640640
The `'error'` event is emitted whenever:
641641

@@ -672,7 +672,7 @@ See `waitpid(2)`.
672672
### Event: 'message'
673673

674674
* `message` {Object} a parsed JSON object or primitive value.
675-
* `sendHandle` {Handle object} a [`net.Socket`][] or [`net.Server`][] object, or
675+
* `sendHandle` {Handle} a [`net.Socket`][] or [`net.Server`][] object, or
676676
undefined.
677677

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

737737
### child.pid
738738

739-
* {Integer}
739+
* {Number} Integer
740740

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

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

755755
* `message` {Object}
756-
* `sendHandle` {Handle object}
756+
* `sendHandle` {Handle}
757757
* `callback` {Function}
758-
* Return: Boolean
758+
* Return: {Boolean}
759759

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

896896
### child.stderr
897897

898-
* {Stream object}
898+
* {Stream}
899899

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

@@ -907,7 +907,7 @@ the same value.
907907

908908
### child.stdin
909909

910-
* {Stream object}
910+
* {Stream}
911911

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

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

960960
### child.stdout
961961

962-
* {Stream object}
962+
* {Stream}
963963

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

‎doc/api/cluster.markdown‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ it is [`kill`][].
331331

332332
### worker.process
333333

334-
* {ChildProcess object}
334+
* {ChildProcess}
335335

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

348348
* `message` {Object}
349-
* `sendHandle` {Handle object}
349+
* `sendHandle` {Handle}
350350
* `callback` {Function}
351351
* Return: Boolean
352352

@@ -394,7 +394,7 @@ worker.kill();
394394

395395
## Event: 'disconnect'
396396

397-
* `worker` {Worker object}
397+
* `worker` {cluster.Worker}
398398

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

413413
## Event: 'exit'
414414

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

434434
## Event: 'fork'
435435

436-
* `worker` {Worker object}
436+
* `worker` {cluster.Worker}
437437

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

459459
## Event: 'listening'
460460

461-
* `worker` {Worker object}
461+
* `worker` {cluster.Worker}
462462
* `address` {Object}
463463

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

486486
## Event: 'message'
487487

488-
* `worker` {Worker object}
488+
* `worker` {cluster.Worker}
489489
* `message` {Object}
490490

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

495495
## Event: 'online'
496496

497-
* `worker` {Worker object}
497+
* `worker` {cluster.Worker}
498498

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

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

541541
Spawn a new worker process.
542542

‎doc/api/crypto.markdown‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -722,8 +722,8 @@ The `private_key` argument can be an object or a string. If `private_key` is a
722722
string, it is treated as a raw key with no passphrase. If `private_key` is an
723723
object, it is interpreted as a hash containing two properties:
724724

725-
* `key` : A string holding the PEM encoded private key
726-
* `passphrase` : A string of passphrase for the private key
725+
* `key` : {String} - PEM encoded private key
726+
* `passphrase` : {String} - passphrase for the private key
727727

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

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

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

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

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

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

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

1204-
* `key` : A string holding the PEM encoded public key
1205-
* `passphrase` : An optional string of passphrase for the private key
1204+
* `key` : {String} - PEM encoded public key
1205+
* `passphrase` : {String} - Optional passphrase for the private key
12061206
* `padding` : An optional padding value, one of the following:
12071207
* `constants.RSA_NO_PADDING`
12081208
* `constants.RSA_PKCS1_PADDING`

0 commit comments

Comments
 (0)