Skip to content

Commit 71bc32c

Browse files
trivikrBridgeAR
authored andcommitted
doc: add extends for derived classes
PR-URL: #29290 Reviewed-By: James M Snell <[email protected]>
1 parent 4eedc4f commit 71bc32c

File tree

9 files changed

+34
-26
lines changed

9 files changed

+34
-26
lines changed

doc/api/child_process.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -895,8 +895,9 @@ arbitrary command execution.**
895895
added: v2.2.0
896896
-->
897897

898-
Instances of the `ChildProcess` class are [`EventEmitters`][`EventEmitter`] that
899-
represent spawned child processes.
898+
* Extends: {EventEmitter}
899+
900+
Instances of the `ChildProcess` represent spawned child processes.
900901

901902
Instances of `ChildProcess` are not intended to be created directly. Rather,
902903
use the [`child_process.spawn()`][], [`child_process.exec()`][],

doc/api/cluster.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,8 @@ also be used for other use cases requiring worker processes.
116116
added: v0.7.0
117117
-->
118118

119+
* Extends: {EventEmitter}
120+
119121
A `Worker` object contains all public information and method about a worker.
120122
In the master it can be obtained using `cluster.workers`. In a worker
121123
it can be obtained using `cluster.worker`.

doc/api/dgram.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,9 @@ server.bind(41234);
3535
added: v0.1.99
3636
-->
3737

38-
The `dgram.Socket` object is an [`EventEmitter`][] that encapsulates the
39-
datagram functionality.
38+
* Extends: {EventEmitter}
39+
40+
Encapsulates the datagram functionality.
4041

4142
New instances of `dgram.Socket` are created using [`dgram.createSocket()`][].
4243
The `new` keyword is not to be used to create `dgram.Socket` instances.
@@ -720,7 +721,6 @@ and `udp6` sockets). The bound address and port can be retrieved using
720721
[`Error`]: errors.html#errors_class_error
721722
[`ERR_SOCKET_DGRAM_IS_CONNECTED`]: errors.html#errors_err_socket_dgram_is_connected
722723
[`ERR_SOCKET_DGRAM_NOT_CONNECTED`]: errors.html#errors_err_socket_dgram_not_connected
723-
[`EventEmitter`]: events.html
724724
[`System Error`]: errors.html#errors_class_systemerror
725725
[`close()`]: #dgram_socket_close_callback
726726
[`cluster`]: cluster.html

doc/api/domain.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -273,11 +273,12 @@ serverDomain.run(() => {
273273

274274
## Class: Domain
275275

276+
* Extends: {EventEmitter}
277+
276278
The `Domain` class encapsulates the functionality of routing errors and
277279
uncaught exceptions to the active `Domain` object.
278280

279-
`Domain` is a child class of [`EventEmitter`][]. To handle the errors that it
280-
catches, listen to its `'error'` event.
281+
To handle the errors that it catches, listen to its `'error'` event.
281282

282283
### domain.members
283284

@@ -475,7 +476,6 @@ Promises. In other words, no `'error'` event will be emitted for unhandled
475476
`Promise` rejections.
476477

477478
[`Error`]: errors.html#errors_class_error
478-
[`EventEmitter`]: events.html#events_class_eventemitter
479479
[`domain.add(emitter)`]: #domain_domain_add_emitter
480480
[`domain.bind(callback)`]: #domain_domain_bind_callback
481481
[`domain.exit()`]: #domain_domain_exit

doc/api/inspector.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@ An exception will be thrown if there is no active inspector.
6464

6565
## Class: inspector.Session
6666

67+
* Extends: {EventEmitter}
68+
6769
The `inspector.Session` is used for dispatching messages to the V8 inspector
6870
back-end and receiving message responses and notifications.
6971

@@ -76,8 +78,6 @@ Create a new instance of the `inspector.Session` class. The inspector session
7678
needs to be connected through [`session.connect()`][] before the messages
7779
can be dispatched to the inspector backend.
7880

79-
`inspector.Session` is an [`EventEmitter`][] with the following events:
80-
8181
### Event: 'inspectorNotification'
8282
<!-- YAML
8383
added: v8.0.0
@@ -217,7 +217,6 @@ session.post('HeapProfiler.takeHeapSnapshot', null, (err, r) => {
217217
```
218218

219219
[`'Debugger.paused'`]: https://chromedevtools.github.io/devtools-protocol/v8/Debugger#event-paused
220-
[`EventEmitter`]: events.html#events_class_eventemitter
221220
[`session.connect()`]: #inspector_session_connect
222221
[CPU Profiler]: https://chromedevtools.github.io/devtools-protocol/v8/Profiler
223222
[Chrome DevTools Protocol Viewer]: https://chromedevtools.github.io/devtools-protocol/v8/

doc/api/net.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ net.createServer().listen(
6060
added: v0.1.90
6161
-->
6262

63+
* Extends: {EventEmitter}
64+
6365
This class is used to create a TCP or [IPC][] server.
6466

6567
### new net.Server([options][, connectionListener])
@@ -384,10 +386,11 @@ active server in the event system. If the server is already `unref`ed calling
384386
added: v0.3.4
385387
-->
386388

389+
* Extends: {stream.Duplex}
390+
387391
This class is an abstraction of a TCP socket or a streaming [IPC][] endpoint
388-
(uses named pipes on Windows, and Unix domain sockets otherwise). A
389-
`net.Socket` is also a [duplex stream][], so it can be both readable and
390-
writable, and it is also an [`EventEmitter`][].
392+
(uses named pipes on Windows, and Unix domain sockets otherwise). It is also
393+
an [`EventEmitter`][].
391394

392395
A `net.Socket` can be created by the user and used directly to interact with
393396
a server. For example, it is returned by [`net.createConnection()`][],
@@ -1234,7 +1237,6 @@ Returns `true` if input is a version 6 IP address, otherwise returns `false`.
12341237
[IPC]: #net_ipc_support
12351238
[Identifying paths for IPC connections]: #net_identifying_paths_for_ipc_connections
12361239
[Readable Stream]: stream.html#stream_class_stream_readable
1237-
[duplex stream]: stream.html#stream_class_stream_duplex
12381240
[half-closed]: https://tools.ietf.org/html/rfc1122
12391241
[stream_writable_write]: stream.html#stream_writable_write_chunk_encoding_callback
12401242
[unspecified IPv4 address]: https://en.wikipedia.org/wiki/0.0.0.0

doc/api/readline.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ received on the `input` stream.
3838
added: v0.1.104
3939
-->
4040

41+
* Extends: {EventEmitter}
42+
4143
Instances of the `readline.Interface` class are constructed using the
4244
`readline.createInterface()` method. Every instance is associated with a
4345
single `input` [Readable][] stream and a single `output` [Writable][] stream.

doc/api/repl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,8 @@ function myWriter(output) {
333333
added: v0.1.91
334334
-->
335335

336-
The `repl.REPLServer` class inherits from the [`readline.Interface`][] class.
336+
* Extends: {readline.Interface}
337+
337338
Instances of `repl.REPLServer` are created using the `repl.start()` method and
338339
*should not* be created directly using the JavaScript `new` keyword.
339340

@@ -696,7 +697,6 @@ For an example of running a REPL instance over [curl(1)][], see:
696697
[`domain`]: domain.html
697698
[`process.setUncaughtExceptionCaptureCallback()`]: process.html#process_process_setuncaughtexceptioncapturecallback_fn
698699
[`readline.InterfaceCompleter`]: readline.html#readline_use_of_the_completer_function
699-
[`readline.Interface`]: readline.html#readline_class_interface
700700
[`repl.ReplServer`]: #repl_class_replserver
701701
[`util.inspect()`]: util.html#util_util_inspect_object_options
702702
[curl(1)]: https://curl.haxx.se/docs/manpage.html

doc/api/tty.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,11 @@ classes.
3535
added: v0.5.8
3636
-->
3737

38-
The `tty.ReadStream` class is a subclass of [`net.Socket`][] that represents the
39-
readable side of a TTY. In normal circumstances [`process.stdin`][] will be the
40-
only `tty.ReadStream` instance in a Node.js process and there should be no
41-
reason to create additional instances.
38+
* Extends: {net.Socket}
39+
40+
Represents the readable side of a TTY. In normal circumstances
41+
[`process.stdin`][] will be the only `tty.ReadStream` instance in a Node.js
42+
process and there should be no reason to create additional instances.
4243

4344
### readStream.isRaw
4445
<!-- YAML
@@ -78,10 +79,12 @@ terminal is disabled, including echoing input characters.
7879
added: v0.5.8
7980
-->
8081

81-
The `tty.WriteStream` class is a subclass of [`net.Socket`][] that represents
82-
the writable side of a TTY. In normal circumstances, [`process.stdout`][] and
83-
[`process.stderr`][] will be the only `tty.WriteStream` instances created for a
84-
Node.js process and there should be no reason to create additional instances.
82+
* Extends: {net.Socket}
83+
84+
Represents the writable side of a TTY. In normal circumstances,
85+
[`process.stdout`][] and [`process.stderr`][] will be the only
86+
`tty.WriteStream` instances created for a Node.js process and there
87+
should be no reason to create additional instances.
8588

8689
### Event: 'resize'
8790
<!-- YAML
@@ -284,7 +287,6 @@ The `tty.isatty()` method returns `true` if the given `fd` is associated with
284287
a TTY and `false` if it is not, including whenever `fd` is not a non-negative
285288
integer.
286289

287-
[`net.Socket`]: net.html#net_class_net_socket
288290
[`process.stderr`]: process.html#process_process_stderr
289291
[`process.stdin`]: process.html#process_process_stdin
290292
[`process.stdout`]: process.html#process_process_stdout

0 commit comments

Comments
 (0)