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 <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Chris Dickinson <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
nodejs · Feb 22, 2016 · 73e0195 · 73e0195
1 parent 154772c
commit 73e0195
Show file tree

Hide file tree

Showing 11 changed files with 104 additions and 99 deletions.
diff --git a/doc/api/buffer.markdown b/doc/api/buffer.markdown
@@ -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}
@@ -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}
@@ -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}

diff --git a/doc/api/child_process.markdown b/doc/api/child_process.markdown
@@ -132,7 +132,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.
@@ -199,7 +199,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`
@@ -235,7 +235,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.
@@ -277,7 +277,7 @@ not clone the current process.*
     [`options.detached`][])
   * `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.spawn()` method spawns a new process using the given
 `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
 
 ### Event:  'error'
 
-* `err` {Error Object} the error.
+* `err` {Error} the error.
 
 The `'error'` event is emitted whenever:
 
@@ -663,7 +663,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
   undefined.
 
 The `'message'` event is triggered when a child process uses `process.send()`
@@ -727,7 +727,7 @@ See `kill(2)`
 
 ### child.pid
 
-* {Integer}
+* {Number} Integer
 
 Returns the process identifier (PID) of the child process.
 
@@ -744,9 +744,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
@@ -886,7 +886,7 @@ this occurs.
 
 ### child.stderr
 
-* {Stream object}
+* {Stream}
 
 A `Readable Stream` that represents the child process's `stderr`.
 
@@ -898,7 +898,7 @@ the same value.
 
 ### child.stdin
 
-* {Stream object}
+* {Stream}
 
 A `Writable Stream` that represents the child process's `stdin`.
 
@@ -950,7 +950,7 @@ assert.equal(child.stdio[2], child.stderr);
 
 ### child.stdout
 
-* {Stream object}
+* {Stream}
 
 A `Readable Stream` that represents the child process's `stdout`.
 

diff --git a/doc/api/cluster.markdown b/doc/api/cluster.markdown
@@ -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`
@@ -346,7 +346,7 @@ disconnection.
 ### worker.send(message[, sendHandle][, callback])
 
 * `message` {Object}
-* `sendHandle` {Handle object}
+* `sendHandle` {Handle}
 * `callback` {Function}
 * Return: Boolean
 
@@ -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
@@ -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.
@@ -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.
@@ -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
@@ -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.
@@ -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.
@@ -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.
 

diff --git a/doc/api/crypto.markdown b/doc/api/crypto.markdown
@@ -710,8 +710,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
+* `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
@@ -850,16 +850,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
@@ -1134,8 +1134,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`
@@ -1152,8 +1152,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`
@@ -1170,8 +1170,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`
@@ -1191,8 +1191,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`