doc,crypto: add extends for derived classes

PR-URL: #29302 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
nodejs · Sep 4, 2019 · ae810cc · ae810cc
1 parent a94afed
commit ae810cc
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
@@ -169,6 +169,8 @@ console.log(cert.verifySpkac(Buffer.from(spkac)));
 added: v0.1.94
 -->
 
+* Extends: {stream.Transform}
+
 Instances of the `Cipher` class are used to encrypt data. The class can be
 used in one of two ways:
 
@@ -354,6 +356,8 @@ The `cipher.update()` method can be called multiple times with new data until
 added: v0.1.94
 -->
 
+* Extends: {stream.Transform}
+
 Instances of the `Decipher` class are used to decrypt data. The class can be
 used in one of two ways:
 
@@ -950,6 +954,8 @@ console.log(aliceSecret === bobSecret);
 added: v0.1.92
 -->
 
+* Extends: {stream.Transform}
+
 The `Hash` class is a utility for creating hash digests of data. It can be
 used in one of two ways:
 
@@ -1044,6 +1050,8 @@ This can be called many times with new data as it is streamed.
 added: v0.1.94
 -->
 
+* Extends: {stream.Transform}
+
 The `Hmac` class is a utility for creating cryptographic HMAC digests. It can
 be used in one of two ways:
 
@@ -1252,6 +1260,8 @@ or `'private'` for private (asymmetric) keys.
 added: v0.1.92
 -->
 
+* Extends: {stream.Writable}
+
 The `Sign` class is a utility for generating signatures. It can be used in one
 of two ways:
 
@@ -1377,6 +1387,8 @@ This can be called many times with new data as it is streamed.
 added: v0.1.92
 -->
 
+* Extends: {stream.Writable}
+
 The `Verify` class is a utility for verifying signatures. It can be used in one
 of two ways:
 

diff --git a/tools/doc/type-parser.js b/tools/doc/type-parser.js
@@ -123,6 +123,7 @@ const customTypesMap = {
   'Stream': 'stream.html#stream_stream',
   'stream.Duplex': 'stream.html#stream_class_stream_duplex',
   'stream.Readable': 'stream.html#stream_class_stream_readable',
+  'stream.Transform': 'stream.html#stream_class_stream_transform',
   'stream.Writable': 'stream.html#stream_class_stream_writable',
 
   'Immediate': 'timers.html#timers_class_immediate',