From 423a58d66fadfa256732325f6996926293ebee73 Mon Sep 17 00:00:00 2001 From: Sakthipriyan Vairamani Date: Wed, 27 Jan 2016 19:19:05 +0530 Subject: [PATCH] doc: show links consistently in deprecations PR-URL: https://github.com/nodejs/node/pull/4907 Reviewed-By: Roman Reiss Reviewed-By: James M Snell --- doc/api/crypto.markdown | 4 ++-- doc/api/net.markdown | 4 ++-- doc/api/tls.markdown | 4 ++-- doc/api/util.markdown | 15 ++++++++------- 4 files changed, 14 insertions(+), 13 deletions(-) diff --git a/doc/api/crypto.markdown b/doc/api/crypto.markdown index 5380719180ea35..56e4bbd222ecbe 100644 --- a/doc/api/crypto.markdown +++ b/doc/api/crypto.markdown @@ -854,7 +854,7 @@ The `key` is the raw key used by the `algorithm` and `iv` is an ### crypto.createCredentials(details) - Stability: 0 - Deprecated: Use [`tls.createSecureContext`][] instead. + Stability: 0 - Deprecated: Use [`tls.createSecureContext()`][] instead. The `crypto.createCredentials()` method is a deprecated alias for creating and returning a `tls.SecureContext` object. The `crypto.createCredentials()` @@ -1339,7 +1339,7 @@ See the reference for other recommendations and details. [`diffieHellman.setPublicKey()`]: #crypto_diffiehellman_setpublickey_public_key_encoding [`EVP_BytesToKey`]: https://www.openssl.org/docs/crypto/EVP_BytesToKey.html [`getCurves()`]: #crypto_crypto_getcurves -[`tls.createSecureContext`]: tls.html#tls_tls_createsecurecontext_details +[`tls.createSecureContext()`]: tls.html#tls_tls_createsecurecontext_details [`Buffer`]: buffer.html [buffers]: buffer.html [Caveats]: #crypto_support_for_weak_or_compromised_algorithms diff --git a/doc/api/net.markdown b/doc/api/net.markdown index 03e0d41cc2bb95..2cc9870c6672ac 100644 --- a/doc/api/net.markdown +++ b/doc/api/net.markdown @@ -71,7 +71,7 @@ was not open when it was closed. ### server.connections - Stability: 0 - Deprecated: Use [`server.getConnections`][] instead. + Stability: 0 - Deprecated: Use [`server.getConnections()`][] instead. The number of concurrent connections on the server. @@ -717,7 +717,7 @@ Returns true if input is a version 6 IP address, otherwise returns false. [`net.Socket`]: #net_class_net_socket [`pause()`]: #net_socket_pause [`resume()`]: #net_socket_resume -[`server.getConnections`]: #net_server_getconnections_callback +[`server.getConnections()`]: #net_server_getconnections_callback [`server.listen(port, \[host\], \[backlog\], \[callback\])`]: #net_server_listen_port_hostname_backlog_callback [`socket.connect(options\[, connectListener\])`]: #net_socket_connect_options_connectlistener [`socket.connect`]: #net_socket_connect_options_connectlistener diff --git a/doc/api/tls.markdown b/doc/api/tls.markdown index 1ecaa2174b1568..dd924dc909ac7a 100644 --- a/doc/api/tls.markdown +++ b/doc/api/tls.markdown @@ -155,7 +155,7 @@ is expensive. ## Class: CryptoStream - Stability: 0 - Deprecated: Use [tls.TLSSocket][] instead. + Stability: 0 - Deprecated: Use [`tls.TLSSocket()`][] instead. This is an encrypted stream. @@ -958,7 +958,7 @@ console.log(ciphers); // ['AES128-SHA', 'AES256-SHA', ...] [crypto.getCurves()]: crypto.html#crypto_crypto_getcurves [tls.createServer]: #tls_tls_createserver_options_secureconnectionlistener [tls.createSecurePair]: #tls_tls_createsecurepair_context_isserver_requestcert_rejectunauthorized_options -[tls.TLSSocket]: #tls_class_tls_tlssocket +[`tls.TLSSocket()`]: #tls_class_tls_tlssocket [`net.Server`]: net.html#net_class_net_server [`net.Socket`]: net.html#net_class_net_socket [net.Server.address()]: net.html#net_server_address diff --git a/doc/api/util.markdown b/doc/api/util.markdown index 9633e0e388dd8e..d15e46cea08dcb 100644 --- a/doc/api/util.markdown +++ b/doc/api/util.markdown @@ -14,7 +14,7 @@ are unnecessary for Node.js's internal functionality. ## util.debug(string) - Stability: 0 - Deprecated: use console.error() instead. + Stability: 0 - Deprecated: Use [`console.error()`][] instead. Deprecated predecessor of `console.error`. @@ -83,7 +83,7 @@ when the deprecated API is used. Configurable at run-time through the ## util.error([...]) - Stability: 0 - Deprecated: Use console.error() instead. + Stability: 0 - Deprecated: Use [`console.error()`][] instead. Deprecated predecessor of `console.error`. @@ -286,9 +286,7 @@ util.isBoolean(false) ## util.isBuffer(object) - Stability: 0 - Deprecated - -Use `Buffer.isBuffer()` instead. + Stability: 0 - Deprecated: Use [`Buffer.isBuffer()`][] instead. Returns `true` if the given "object" is a `Buffer`. `false` otherwise. @@ -538,7 +536,7 @@ Output with timestamp on `stdout`. ## util.print([...]) - Stability: 0 - Deprecated: Use `console.log` instead. + Stability: 0 - Deprecated: Use [`console.log()`][] instead. Deprecated predecessor of `console.log`. @@ -550,7 +548,7 @@ Deprecated predecessor of `stream.pipe()`. ## util.puts([...]) - Stability: 0 - Deprecated: Use console.log() instead. + Stability: 0 - Deprecated: Use [`console.log()`][] instead. Deprecated predecessor of `console.log`. @@ -559,3 +557,6 @@ Deprecated predecessor of `console.log`. [Customizing `util.inspect` colors]: #util_customizing_util_inspect_colors [here]: #util_customizing_util_inspect_colors [`Error`]: errors.html#errors_class_error +[`console.log()`]: console.html#console_console_log_data +[`console.error()`]: console.html#console_console_error_data +[`Buffer.isBuffer()`]: buffer.html#buffer_class_method_buffer_isbuffer_obj