diff options
author | Sho Miyamoto <shqld8@gmail.com> | 2018-02-22 05:09:55 +0900 |
---|---|---|
committer | Benjamin Gruenbaum <benji@peer5.com> | 2018-02-26 16:46:55 +0200 |
commit | 646e67e1dca9df6ca8e81dcbfa683d2623110c85 (patch) | |
tree | 371a867739e3dd62710e1e18b57f5ddd29de4d30 /doc | |
parent | 1bb92ce04fdf516742f6462d5b26dabc558183a6 (diff) | |
download | android-node-v8-646e67e1dca9df6ca8e81dcbfa683d2623110c85.tar.gz android-node-v8-646e67e1dca9df6ca8e81dcbfa683d2623110c85.tar.bz2 android-node-v8-646e67e1dca9df6ca8e81dcbfa683d2623110c85.zip |
doc: remove `Returns: {undefined}`
Removed * Returns: {undefined} in doc/ to prevent confusing users
PR-URL: https://github.com/nodejs/node/pull/18951
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/async_hooks.md | 6 | ||||
-rw-r--r-- | doc/api/fs.md | 1 | ||||
-rw-r--r-- | doc/api/http2.md | 9 |
3 files changed, 0 insertions, 16 deletions
diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md index ff7b794a30..bb739d3a0b 100644 --- a/doc/api/async_hooks.md +++ b/doc/api/async_hooks.md @@ -686,8 +686,6 @@ deprecated: v9.6.0 --> > Stability: 0 - Deprecated: Use [`asyncResource.runInAsyncScope()`][] instead. -* Returns: {undefined} - Call all `before` callbacks to notify that a new asynchronous execution context is being entered. If nested calls to `emitBefore()` are made, the stack of `asyncId`s will be tracked and properly unwound. @@ -704,8 +702,6 @@ deprecated: v9.6.0 --> > Stability: 0 - Deprecated: Use [`asyncResource.runInAsyncScope()`][] instead. -* Returns: {undefined} - Call all `after` callbacks. If nested calls to `emitBefore()` were made, then make sure the stack is unwound properly. Otherwise an error will be thrown. @@ -721,8 +717,6 @@ alternative. #### `asyncResource.emitDestroy()` -* Returns: {undefined} - Call all `destroy` hooks. This should only ever be called once. An error will be thrown if it is called more than once. This **must** be manually called. If the resource is left to be collected by the GC then the `destroy` hooks will diff --git a/doc/api/fs.md b/doc/api/fs.md index 27650c42cd..e5ffae410a 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -788,7 +788,6 @@ changes: * `path` {string|Buffer|URL} * `mode` {integer} **Default:** `fs.constants.F_OK` -* Returns: {undefined} Synchronously tests a user's permissions for the file or directory specified by `path`. The `mode` argument is an optional integer that specifies the diff --git a/doc/api/http2.md b/doc/api/http2.md index 14dae38b49..94f25377d0 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -327,7 +327,6 @@ added: v8.4.0 * `code` {number} The HTTP/2 error code to send in the final `GOAWAY` frame. If unspecified, and `error` is not undefined, the default is `INTERNAL_ERROR`, otherwise defaults to `NO_ERROR`. -* Returns: {undefined} Immediately terminates the `Http2Session` and the associated `net.Socket` or `tls.TLSSocket`. @@ -470,7 +469,6 @@ added: v8.4.0 * `msecs` {number} * `callback` {Function} -* Returns: {undefined} Used to set a callback function that is called when there is no activity on the `Http2Session` after `msecs` milliseconds. The given `callback` is @@ -530,7 +528,6 @@ added: v8.4.0 --> * `settings` {HTTP2 Settings Object} -* Returns {undefined} Updates the current local settings for this `Http2Session` and sends a new `SETTINGS` frame to the connected HTTP/2 peer. @@ -882,7 +879,6 @@ added: v8.4.0 `http2.constants.NGHTTP2_NO_ERROR` (`0x00`) * `callback` {Function} An optional function registered to listen for the `'close'` event. -* Returns: {undefined} Closes the `Http2Stream` instance by sending an `RST_STREAM` frame to the connected HTTP/2 peer. @@ -933,7 +929,6 @@ added: v8.4.0 and `256` (inclusive). * `silent` {boolean} When `true`, changes the priority locally without sending a `PRIORITY` frame to the connected peer. -* Returns: {undefined} Updates the priority for this `Http2Stream` instance. @@ -994,7 +989,6 @@ added: v8.4.0 * `msecs` {number} * `callback` {Function} -* Returns: {undefined} ```js const http2 = require('http2'); @@ -1117,7 +1111,6 @@ added: v8.4.0 --> * `headers` {HTTP2 Headers Object} -* Returns: {undefined} Sends an additional informational `HEADERS` frame to the connected HTTP/2 peer. @@ -1161,7 +1154,6 @@ added: v8.4.0 * `pushStream` {ServerHttp2Stream} The returned pushStream object. * `headers` {HTTP2 Headers Object} Headers object the pushStream was initiated with. -* Returns: {undefined} Initiates a push stream. The callback is invoked with the new `Http2Stream` instance created for the push stream passed as the second argument, or an @@ -1196,7 +1188,6 @@ added: v8.4.0 include payload data. * `getTrailers` {Function} Callback function invoked to collect trailer headers. -* Returns: {undefined} ```js const http2 = require('http2'); |