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.
nodejs · Jun 15, 2012 · c6185c8 · c6185c8
1 parent a111390
commit c6185c8
Show file tree

Hide file tree

Showing 11 changed files with 171 additions and 131 deletions.
diff --git a/doc/api/child_process.markdown b/doc/api/child_process.markdown
@@ -14,7 +14,7 @@ different, and explained below.
 
 ## Class: ChildProcess
 
-`ChildProcess` is an `EventEmitter`.
+`ChildProcess` is an [EventEmitter][].
 
 Child processes always have three streams associated with them. `child.stdin`,
 `child.stdout`, and `child.stderr`.  These may be shared with the stdio
@@ -496,7 +496,7 @@ the child process is killed.
   * `env` {Object} Environment key-value pairs
   * `encoding` {String} (Default: 'utf8')
   * `timeout` {Number} (Default: 0)
-  * `maxBuffer` {Number} (Default: 200*1024)
+  * `maxBuffer` {Number} (Default: 200\*1024)
   * `killSignal` {String} (Default: 'SIGTERM')
 * `callback` {Function} called with the output when process terminates
   * `error` {Error}
@@ -509,7 +509,7 @@ subshell but rather the specified file directly. This makes it slightly
 leaner than `child_process.exec`. It has the same options.
 
 
-## child_process.fork(modulePath, [args], [options])
+## child\_process.fork(modulePath, [args], [options])
 
 * `modulePath` {String} The module to run in the child
 * `args` {Array} List of string arguments
@@ -532,3 +532,5 @@ with the parent's. To change this behavior set the `silent` property in the
 These child Nodes are still whole new instances of V8. Assume at least 30ms
 startup and 10mb memory for each new Node. That is, you cannot create many
 thousands of them.
+
+[EventEmitter]: events.html#events_class_events_eventemitter
diff --git a/doc/api/crypto.markdown b/doc/api/crypto.markdown
@@ -159,12 +159,12 @@ Useful for non-standard padding, e.g. using `0x0` instead of PKCS padding. You m
 ## crypto.createDecipher(algorithm, password)
 
 Creates and returns a decipher object, with the given algorithm and key.
-This is the mirror of the [createCipher()](#crypto.createCipher) above.
+This is the mirror of the [createCipher()][] above.
 
 ## crypto.createDecipheriv(algorithm, key, iv)
 
 Creates and returns a decipher object, with the given algorithm, key and iv.
-This is the mirror of the [createCipheriv()](#crypto.createCipheriv) above.
+This is the mirror of the [createCipheriv()][] above.
 
 ## Class: Decipher
 
@@ -316,13 +316,13 @@ or `'base64'`. Defaults to `'binary'`.
 
 Creates a predefined Diffie-Hellman key exchange object.
 The supported groups are: `'modp1'`, `'modp2'`, `'modp5'`
-(defined in [RFC 2412](http://www.rfc-editor.org/rfc/rfc2412.txt ))
+(defined in [RFC 2412][])
 and `'modp14'`, `'modp15'`, `'modp16'`, `'modp17'`, `'modp18'`
-(defined in [RFC 3526](http://www.rfc-editor.org/rfc/rfc3526.txt )).
+(defined in [RFC 3526][]).
 The returned object mimics the interface of objects created by
-[crypto.createDiffieHellman()](#crypto.createDiffieHellman) above, but
+[crypto.createDiffieHellman()][] above, but
 will not allow to change the keys (with
-[diffieHellman.setPublicKey()](#diffieHellman.setPublicKey) for example).
+[diffieHellman.setPublicKey()][] for example).
 The advantage of using this routine is that the parties don't have to
 generate nor exchange group modulus beforehand, saving both processor and
 communication time.
@@ -365,3 +365,10 @@ Generates cryptographically strong pseudo-random data. Usage:
     } catch (ex) {
       // handle error
     }
+
+[createCipher()]: #crypto_crypto_createcipher_algorithm_password
+[createCipheriv()]: #crypto_crypto_createcipheriv_algorithm_key_iv
+[crypto.createDiffieHellman()]: #crypto_crypto_creatediffiehellman_prime_encoding
+[diffieHellman.setPublicKey()]: #crypto_diffiehellman_setpublickey_public_key_encoding
+[RFC 2412]: http://www.rfc-editor.org/rfc/rfc2412.txt
+[RFC 3526]: http://www.rfc-editor.org/rfc/rfc3526.txt
diff --git a/doc/api/domain.markdown b/doc/api/domain.markdown
@@ -119,7 +119,7 @@ Returns a new Domain object.
 The Domain class encapsulates the functionality of routing errors and
 uncaught exceptions to the active Domain object.
 
-Domain is a child class of EventEmitter.  To handle the errors that it
+Domain is a child class of [EventEmitter][].  To handle the errors that it
 catches, listen to its `error` event.
 
 ### domain.run(fn)
@@ -264,3 +264,5 @@ Note that IO might still be performed.  However, to the highest degree
 possible, once a domain is disposed, further errors from the emitters in
 that set will be ignored.  So, even if some remaining actions are still
 in flight, Node.js will not communicate further about them.
+
+[EventEmitter]: events.html#events_class_events_eventemitter
diff --git a/doc/api/globals.markdown b/doc/api/globals.markdown
@@ -22,32 +22,32 @@ scope; `var something` inside a Node module will be local to that module.
 
 * {Object}
 
-The process object. See the [process object](process.html#process) section.
+The process object. See the [process object][] section.
 
 ## console
 
 <!-- type=global -->
 
 * {Object}
 
-Used to print to stdout and stderr. See the [stdio](stdio.html) section.
+Used to print to stdout and stderr. See the [stdio][] section.
 
 ## Class: Buffer
 
 <!-- type=global -->
 
 * {Function}
 
-Used to handle binary data. See the [buffer section](buffer.html).
+Used to handle binary data. See the [buffer section][]
 
 ## require()
 
 <!-- type=var -->
 
 * {Function}
 
-To require modules. See the [Modules](modules.html#modules) section.
-`require` isn't actually a global but rather local to each module.
+To require modules. See the [Modules][] section.  `require` isn't actually a
+global but rather local to each module.
 
 ### require.resolve()
 
@@ -123,8 +123,7 @@ A reference to the current module. In particular
 `module.exports` is the same as the `exports` object.
 `module` isn't actually a global but rather local to each module.
 
-See the [module system documentation](modules.html) for more
-information.
+See the [module system documentation][] for more information.
 
 ## exports
 
@@ -135,10 +134,9 @@ made accessible through `require()`.
 `exports` is the same as the `module.exports` object.
 `exports` isn't actually a global but rather local to each module.
 
-See the [module system documentation](modules.html) for more
-information.
+See the [module system documentation][] for more information.
 
-See the [module section](modules.html) for more information.
+See the [module section][] for more information.
 
 ## setTimeout(cb, ms)
 ## clearTimeout(t)
@@ -147,4 +145,12 @@ See the [module section](modules.html) for more information.
 
 <!--type=global-->
 
-The timer functions are global variables. See the [timers](timers.html) section.
+The timer functions are global variables. See the [timers][] section.
+
+[buffer section]: buffer.html
+[module section]: modules.html
+[module system documentation]: modules.html
+[Modules]: modules.html#modules_modules
+[process object]: process.html#process_process
+[stdio]: stdio.html
+[timers]: timers.html