Skip to content

Commit 73e0195

Browse files
claudiorodriguezMyles Borins
claudiorodriguez
authored and
Myles Borins
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: #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 154772c commit 73e0195

File tree

11 files changed

+104
-99
lines changed

11 files changed

+104
-99
lines changed

‎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
@@ -132,7 +132,7 @@ exec('my.bat', (err, stdout, stderr) => {
132132
* `error` {Error}
133133
* `stdout` {Buffer}
134134
* `stderr` {Buffer}
135-
* Return: ChildProcess object
135+
* Return: {ChildProcess}
136136

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

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

240240
The `child_process.fork()` method is a special case of
241241
[`child_process.spawn()`][] used specifically to spawn new Node.js processes.
@@ -277,7 +277,7 @@ not clone the current process.*
277277
[`options.detached`][])
278278
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
279279
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
280-
* return: {ChildProcess object}
280+
* return: {ChildProcess}
281281

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

627627
### Event: 'error'
628628

629-
* `err` {Error Object} the error.
629+
* `err` {Error} the error.
630630

631631
The `'error'` event is emitted whenever:
632632

@@ -663,7 +663,7 @@ See `waitpid(2)`.
663663
### Event: 'message'
664664

665665
* `message` {Object} a parsed JSON object or primitive value.
666-
* `sendHandle` {Handle object} a [`net.Socket`][] or [`net.Server`][] object, or
666+
* `sendHandle` {Handle} a [`net.Socket`][] or [`net.Server`][] object, or
667667
undefined.
668668

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

728728
### child.pid
729729

730-
* {Integer}
730+
* {Number} Integer
731731

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

@@ -744,9 +744,9 @@ grep.stdin.end();
744744
### child.send(message[, sendHandle][, callback])
745745

746746
* `message` {Object}
747-
* `sendHandle` {Handle object}
747+
* `sendHandle` {Handle}
748748
* `callback` {Function}
749-
* Return: Boolean
749+
* Return: {Boolean}
750750

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

887887
### child.stderr
888888

889-
* {Stream object}
889+
* {Stream}
890890

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

@@ -898,7 +898,7 @@ the same value.
898898

899899
### child.stdin
900900

901-
* {Stream object}
901+
* {Stream}
902902

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

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

951951
### child.stdout
952952

953-
* {Stream object}
953+
* {Stream}
954954

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

‎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
@@ -710,8 +710,8 @@ The `private_key` argument can be an object or a string. If `private_key` is a
710710
string, it is treated as a raw key with no passphrase. If `private_key` is an
711711
object, it is interpreted as a hash containing two properties:
712712

713-
* `key` : A string holding the PEM encoded private key
714-
* `passphrase` : A string of passphrase for the private key
713+
* `key` : {String} - PEM encoded private key
714+
* `passphrase` : {String} - passphrase for the private key
715715

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

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

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

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

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

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

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

1194-
* `key` : A string holding the PEM encoded public key
1195-
* `passphrase` : An optional string of passphrase for the private key
1194+
* `key` : {String} - PEM encoded public key
1195+
* `passphrase` : {String} - Optional passphrase for the private key
11961196
* `padding` : An optional padding value, one of the following:
11971197
* `constants.RSA_NO_PADDING`
11981198
* `constants.RSA_PKCS1_PADDING`

0 commit comments

Comments
 (0)