Skip to content

Commit c6185c8

Browse files
wanderviewisaacs
wanderview
authored and
isaacs
committed
doc: Improve cross-linking in API docs markdown
Cross-link EventEmitter references in API docs to events.html Fix broken cross-reference links with wrong anchor names in API docs.
1 parent a111390 commit c6185c8

11 files changed

Lines changed: 171 additions & 131 deletions

‎doc/api/child_process.markdown‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ different, and explained below.
1414

1515
## Class: ChildProcess
1616

17-
`ChildProcess` is an `EventEmitter`.
17+
`ChildProcess` is an [EventEmitter][].
1818

1919
Child processes always have three streams associated with them. `child.stdin`,
2020
`child.stdout`, and `child.stderr`. These may be shared with the stdio
@@ -496,7 +496,7 @@ the child process is killed.
496496
* `env` {Object} Environment key-value pairs
497497
* `encoding` {String} (Default: 'utf8')
498498
* `timeout` {Number} (Default: 0)
499-
* `maxBuffer` {Number} (Default: 200*1024)
499+
* `maxBuffer` {Number} (Default: 200\*1024)
500500
* `killSignal` {String} (Default: 'SIGTERM')
501501
* `callback` {Function} called with the output when process terminates
502502
* `error` {Error}
@@ -509,7 +509,7 @@ subshell but rather the specified file directly. This makes it slightly
509509
leaner than `child_process.exec`. It has the same options.
510510

511511

512-
## child_process.fork(modulePath, [args], [options])
512+
## child\_process.fork(modulePath, [args], [options])
513513

514514
* `modulePath` {String} The module to run in the child
515515
* `args` {Array} List of string arguments
@@ -532,3 +532,5 @@ with the parent's. To change this behavior set the `silent` property in the
532532
These child Nodes are still whole new instances of V8. Assume at least 30ms
533533
startup and 10mb memory for each new Node. That is, you cannot create many
534534
thousands of them.
535+
536+
[EventEmitter]: events.html#events_class_events_eventemitter

‎doc/api/crypto.markdown‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -159,12 +159,12 @@ Useful for non-standard padding, e.g. using `0x0` instead of PKCS padding. You m
159159
## crypto.createDecipher(algorithm, password)
160160

161161
Creates and returns a decipher object, with the given algorithm and key.
162-
This is the mirror of the [createCipher()](#crypto.createCipher) above.
162+
This is the mirror of the [createCipher()][] above.
163163

164164
## crypto.createDecipheriv(algorithm, key, iv)
165165

166166
Creates and returns a decipher object, with the given algorithm, key and iv.
167-
This is the mirror of the [createCipheriv()](#crypto.createCipheriv) above.
167+
This is the mirror of the [createCipheriv()][] above.
168168

169169
## Class: Decipher
170170

@@ -316,13 +316,13 @@ or `'base64'`. Defaults to `'binary'`.
316316

317317
Creates a predefined Diffie-Hellman key exchange object.
318318
The supported groups are: `'modp1'`, `'modp2'`, `'modp5'`
319-
(defined in [RFC 2412](http://www.rfc-editor.org/rfc/rfc2412.txt ))
319+
(defined in [RFC 2412][])
320320
and `'modp14'`, `'modp15'`, `'modp16'`, `'modp17'`, `'modp18'`
321-
(defined in [RFC 3526](http://www.rfc-editor.org/rfc/rfc3526.txt )).
321+
(defined in [RFC 3526][]).
322322
The returned object mimics the interface of objects created by
323-
[crypto.createDiffieHellman()](#crypto.createDiffieHellman) above, but
323+
[crypto.createDiffieHellman()][] above, but
324324
will not allow to change the keys (with
325-
[diffieHellman.setPublicKey()](#diffieHellman.setPublicKey) for example).
325+
[diffieHellman.setPublicKey()][] for example).
326326
The advantage of using this routine is that the parties don't have to
327327
generate nor exchange group modulus beforehand, saving both processor and
328328
communication time.
@@ -365,3 +365,10 @@ Generates cryptographically strong pseudo-random data. Usage:
365365
} catch (ex) {
366366
// handle error
367367
}
368+
369+
[createCipher()]: #crypto_crypto_createcipher_algorithm_password
370+
[createCipheriv()]: #crypto_crypto_createcipheriv_algorithm_key_iv
371+
[crypto.createDiffieHellman()]: #crypto_crypto_creatediffiehellman_prime_encoding
372+
[diffieHellman.setPublicKey()]: #crypto_diffiehellman_setpublickey_public_key_encoding
373+
[RFC 2412]: http://www.rfc-editor.org/rfc/rfc2412.txt
374+
[RFC 3526]: http://www.rfc-editor.org/rfc/rfc3526.txt

‎doc/api/domain.markdown‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Returns a new Domain object.
119119
The Domain class encapsulates the functionality of routing errors and
120120
uncaught exceptions to the active Domain object.
121121

122-
Domain is a child class of EventEmitter. To handle the errors that it
122+
Domain is a child class of [EventEmitter][]. To handle the errors that it
123123
catches, listen to its `error` event.
124124

125125
### domain.run(fn)
@@ -264,3 +264,5 @@ Note that IO might still be performed. However, to the highest degree
264264
possible, once a domain is disposed, further errors from the emitters in
265265
that set will be ignored. So, even if some remaining actions are still
266266
in flight, Node.js will not communicate further about them.
267+
268+
[EventEmitter]: events.html#events_class_events_eventemitter

‎doc/api/globals.markdown‎

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,32 +22,32 @@ scope; `var something` inside a Node module will be local to that module.
2222

2323
* {Object}
2424

25-
The process object. See the [process object](process.html#process) section.
25+
The process object. See the [process object][] section.
2626

2727
## console
2828

2929
<!-- type=global -->
3030

3131
* {Object}
3232

33-
Used to print to stdout and stderr. See the [stdio](stdio.html) section.
33+
Used to print to stdout and stderr. See the [stdio][] section.
3434

3535
## Class: Buffer
3636

3737
<!-- type=global -->
3838

3939
* {Function}
4040

41-
Used to handle binary data. See the [buffer section](buffer.html).
41+
Used to handle binary data. See the [buffer section][]
4242

4343
## require()
4444

4545
<!-- type=var -->
4646

4747
* {Function}
4848

49-
To require modules. See the [Modules](modules.html#modules) section.
50-
`require` isn't actually a global but rather local to each module.
49+
To require modules. See the [Modules][] section. `require` isn't actually a
50+
global but rather local to each module.
5151

5252
### require.resolve()
5353

@@ -123,8 +123,7 @@ A reference to the current module. In particular
123123
`module.exports` is the same as the `exports` object.
124124
`module` isn't actually a global but rather local to each module.
125125

126-
See the [module system documentation](modules.html) for more
127-
information.
126+
See the [module system documentation][] for more information.
128127

129128
## exports
130129

@@ -135,10 +134,9 @@ made accessible through `require()`.
135134
`exports` is the same as the `module.exports` object.
136135
`exports` isn't actually a global but rather local to each module.
137136

138-
See the [module system documentation](modules.html) for more
139-
information.
137+
See the [module system documentation][] for more information.
140138

141-
See the [module section](modules.html) for more information.
139+
See the [module section][] for more information.
142140

143141
## setTimeout(cb, ms)
144142
## clearTimeout(t)
@@ -147,4 +145,12 @@ See the [module section](modules.html) for more information.
147145

148146
<!--type=global-->
149147

150-
The timer functions are global variables. See the [timers](timers.html) section.
148+
The timer functions are global variables. See the [timers][] section.
149+
150+
[buffer section]: buffer.html
151+
[module section]: modules.html
152+
[module system documentation]: modules.html
153+
[Modules]: modules.html#modules_modules
154+
[process object]: process.html#process_process
155+
[stdio]: stdio.html
156+
[timers]: timers.html

0 commit comments

Comments
 (0)