diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md index 81ca1ef51f007f..745a2376257ed9 100644 --- a/doc/api/async_hooks.md +++ b/doc/api/async_hooks.md @@ -727,7 +727,7 @@ class DBQuery extends AsyncResource { } ``` -#### Class Method: `AsyncResource.bind(fn[, type])` +#### Static method: `AsyncResource.bind(fn[, type])` diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 22ecfc867c5e5a..8cdb910b9f486d 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -284,7 +284,7 @@ Additionally, the [`buf.values()`][], [`buf.keys()`][], and The `Buffer` class is a global type for dealing with binary data directly. It can be constructed in a variety of ways. -### Class Method: `Buffer.alloc(size[, fill[, encoding]])` +### Static method: `Buffer.alloc(size[, fill[, encoding]])` @@ -446,7 +446,7 @@ socket.on('readable', () => { A `TypeError` will be thrown if `size` is not a number. -### Class Method: `Buffer.byteLength(string[, encoding])` +### Static method: `Buffer.byteLength(string[, encoding])` @@ -581,7 +581,7 @@ appropriate for `Buffer.from()` variants. `Buffer.from(array)` and [`Buffer.from(string)`][] may also use the internal `Buffer` pool like [`Buffer.allocUnsafe()`][] does. -### Class Method: `Buffer.from(arrayBuffer[, byteOffset[, length]])` +### Static method: `Buffer.from(arrayBuffer[, byteOffset[, length]])` @@ -632,7 +632,7 @@ A `TypeError` will be thrown if `arrayBuffer` is not an [`ArrayBuffer`][] or a [`SharedArrayBuffer`][] or another type appropriate for `Buffer.from()` variants. -### Class Method: `Buffer.from(buffer)` +### Static method: `Buffer.from(buffer)` @@ -657,7 +657,7 @@ console.log(buf2.toString()); A `TypeError` will be thrown if `buffer` is not a `Buffer` or another type appropriate for `Buffer.from()` variants. -### Class Method: `Buffer.from(object[, offsetOrEncoding[, length]])` +### Static method: `Buffer.from(object[, offsetOrEncoding[, length]])` @@ -691,7 +691,7 @@ const buf = Buffer.from(new Foo(), 'utf8'); A `TypeError` will be thrown if `object` does not have the mentioned methods or is not of another type appropriate for `Buffer.from()` variants. -### Class Method: `Buffer.from(string[, encoding])` +### Static method: `Buffer.from(string[, encoding])` @@ -717,7 +717,7 @@ console.log(buf1.toString('latin1')); A `TypeError` will be thrown if `string` is not a string or another type appropriate for `Buffer.from()` variants. -### Class Method: `Buffer.isBuffer(obj)` +### Static method: `Buffer.isBuffer(obj)` @@ -727,7 +727,7 @@ added: v0.1.101 Returns `true` if `obj` is a `Buffer`, `false` otherwise. -### Class Method: `Buffer.isEncoding(encoding)` +### Static method: `Buffer.isEncoding(encoding)` @@ -3206,13 +3206,13 @@ introducing security vulnerabilities into an application. [RFC 4648, Section 5]: https://tools.ietf.org/html/rfc4648#section-5 [WHATWG Encoding Standard]: https://encoding.spec.whatwg.org/ [`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer -[`Buffer.alloc()`]: #buffer_class_method_buffer_alloc_size_fill_encoding -[`Buffer.allocUnsafe()`]: #buffer_class_method_buffer_allocunsafe_size -[`Buffer.allocUnsafeSlow()`]: #buffer_class_method_buffer_allocunsafeslow_size -[`Buffer.from(array)`]: #buffer_class_method_buffer_from_array -[`Buffer.from(arrayBuf)`]: #buffer_class_method_buffer_from_arraybuffer_byteoffset_length -[`Buffer.from(buffer)`]: #buffer_class_method_buffer_from_buffer -[`Buffer.from(string)`]: #buffer_class_method_buffer_from_string_encoding +[`Buffer.alloc()`]: #buffer_static_method_buffer_alloc_size_fill_encoding +[`Buffer.allocUnsafe()`]: #buffer_static_method_buffer_allocunsafe_size +[`Buffer.allocUnsafeSlow()`]: #buffer_static_method_buffer_allocunsafeslow_size +[`Buffer.from(array)`]: #buffer_static_method_buffer_from_array +[`Buffer.from(arrayBuf)`]: #buffer_static_method_buffer_from_arraybuffer_byteoffset_length +[`Buffer.from(buffer)`]: #buffer_static_method_buffer_from_buffer +[`Buffer.from(string)`]: #buffer_static_method_buffer_from_string_encoding [`Buffer.poolSize`]: #buffer_class_property_buffer_poolsize [`DataView`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView [`ERR_INVALID_BUFFER_SIZE`]: errors.html#ERR_INVALID_BUFFER_SIZE diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 13048337e0ba66..0c872e99823467 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -787,7 +787,7 @@ assert.strictEqual(aliceSecret.toString('hex'), bobSecret.toString('hex')); // OK ``` -### Class Method: `ECDH.convertKey(key, curve[, inputEncoding[, outputEncoding[, format]]])` +### Static method: `ECDH.convertKey(key, curve[, inputEncoding[, outputEncoding[, format]]])` diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 0c68842fe68299..c7583e3a9e97ba 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -2755,10 +2755,10 @@ Type: Documentation-only [`--pending-deprecation`]: cli.html#cli_pending_deprecation [`--throw-deprecation`]: cli.html#cli_throw_deprecation -[`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size -[`Buffer.from(array)`]: buffer.html#buffer_class_method_buffer_from_array -[`Buffer.from(buffer)`]: buffer.html#buffer_class_method_buffer_from_buffer -[`Buffer.isBuffer()`]: buffer.html#buffer_class_method_buffer_isbuffer_obj +[`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_static_method_buffer_allocunsafeslow_size +[`Buffer.from(array)`]: buffer.html#buffer_static_method_buffer_from_array +[`Buffer.from(buffer)`]: buffer.html#buffer_static_method_buffer_from_buffer +[`Buffer.isBuffer()`]: buffer.html#buffer_static_method_buffer_isbuffer_obj [`Cipher`]: crypto.html#crypto_class_cipher [`Decipher`]: crypto.html#crypto_class_decipher [`EventEmitter.listenerCount(emitter, eventName)`]: events.html#events_eventemitter_listenercount_emitter_eventname @@ -2870,8 +2870,8 @@ Type: Documentation-only [NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf [RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3 [WHATWG URL API]: url.html#url_the_whatwg_url_api -[alloc]: buffer.html#buffer_class_method_buffer_alloc_size_fill_encoding -[alloc_unsafe_size]: buffer.html#buffer_class_method_buffer_allocunsafe_size -[from_arraybuffer]: buffer.html#buffer_class_method_buffer_from_arraybuffer_byteoffset_length -[from_string_encoding]: buffer.html#buffer_class_method_buffer_from_string_encoding +[alloc]: buffer.html#buffer_static_method_buffer_alloc_size_fill_encoding +[alloc_unsafe_size]: buffer.html#buffer_static_method_buffer_allocunsafe_size +[from_arraybuffer]: buffer.html#buffer_static_method_buffer_from_arraybuffer_byteoffset_length +[from_string_encoding]: buffer.html#buffer_static_method_buffer_from_string_encoding [legacy `urlObject`]: url.html#url_legacy_urlobject diff --git a/doc/api/dgram.md b/doc/api/dgram.md index 3cc2ea78297228..462f71ed74c775 100644 --- a/doc/api/dgram.md +++ b/doc/api/dgram.md @@ -802,4 +802,4 @@ and `udp6` sockets). The bound address and port can be retrieved using [`socket.bind()`]: #dgram_socket_bind_port_address_callback [IPv6 Zone Indices]: https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_addresses [RFC 4007]: https://tools.ietf.org/html/rfc4007 -[byte length]: buffer.html#buffer_class_method_buffer_bytelength_string_encoding +[byte length]: buffer.html#buffer_static_method_buffer_bytelength_string_encoding diff --git a/doc/api/fs.md b/doc/api/fs.md index adcf875fc5deed..180e89b116528d 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -5855,7 +5855,7 @@ A call to `fs.ftruncate()` or `filehandle.truncate()` can be used to reset the file contents. [`AHAFS`]: https://www.ibm.com/developerworks/aix/library/au-aix_event_infrastructure/ -[`Buffer.byteLength`]: buffer.html#buffer_class_method_buffer_bytelength_string_encoding +[`Buffer.byteLength`]: buffer.html#buffer_static_method_buffer_bytelength_string_encoding [`Buffer`]: buffer.html#buffer_buffer [`FSEvents`]: https://developer.apple.com/documentation/coreservices/file_system_events [`Number.MAX_SAFE_INTEGER`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER diff --git a/doc/api/http.md b/doc/api/http.md index 46067b777484ea..fa60f0c9687cf5 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -2627,7 +2627,7 @@ try { [`'response'`]: #http_event_response [`'upgrade'`]: #http_event_upgrade [`Agent`]: #http_class_http_agent -[`Buffer.byteLength()`]: buffer.html#buffer_class_method_buffer_bytelength_string_encoding +[`Buffer.byteLength()`]: buffer.html#buffer_static_method_buffer_bytelength_string_encoding [`Duplex`]: stream.html#stream_class_stream_duplex [`HPE_HEADER_OVERFLOW`]: errors.html#errors_hpe_header_overflow [`TypeError`]: errors.html#errors_class_typeerror diff --git a/doc/api/util.md b/doc/api/util.md index f21f957bba3eeb..b14c5969f0b416 100644 --- a/doc/api/util.md +++ b/doc/api/util.md @@ -2414,7 +2414,7 @@ util.log('Timestamped message.'); [`Array.isArray()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray [`ArrayBuffer.isView()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView [`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer -[`Buffer.isBuffer()`]: buffer.html#buffer_class_method_buffer_isbuffer_obj +[`Buffer.isBuffer()`]: buffer.html#buffer_static_method_buffer_isbuffer_obj [`DataView`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView [`Date`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date [`Error`]: errors.html#errors_class_error diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md index 7d1f3509c374c3..9b57d28a3e6dd2 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -892,7 +892,7 @@ active handle in the event system. If the worker is already `unref()`ed calling [`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer [`AsyncResource`]: async_hooks.html#async_hooks_class_asyncresource [`Buffer`]: buffer.html -[`Buffer.allocUnsafe()`]: buffer.html#buffer_class_method_buffer_allocunsafe_size +[`Buffer.allocUnsafe()`]: buffer.html#buffer_static_method_buffer_allocunsafe_size [`ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST`]: errors.html#errors_err_missing_message_port_in_transfer_list [`ERR_WORKER_NOT_RUNNING`]: errors.html#ERR_WORKER_NOT_RUNNING [`EventEmitter`]: events.html diff --git a/test/doctool/test-doctool-html.js b/test/doctool/test-doctool-html.js index 30221a7fe18b1a..b03bada053761f 100644 --- a/test/doctool/test-doctool-html.js +++ b/test/doctool/test-doctool-html.js @@ -65,9 +65,9 @@ const testData = [ }, { file: fixtures.path('order_of_end_tags_5873.md'), - html: '

ClassMethod: Buffer.from(array) ' + - '#

' + + html: '

Static method: Buffer.from(array) ' + + '#

' + '' diff --git a/test/doctool/test-doctool-json.js b/test/doctool/test-doctool-json.js index 78afc818e9fae0..36d76cfec8236b 100644 --- a/test/doctool/test-doctool-json.js +++ b/test/doctool/test-doctool-json.js @@ -69,7 +69,7 @@ const testData = [ textRaw: 'Subsection', name: 'subsection', classMethods: [{ - textRaw: 'Class Method: Buffer.from(array)', + textRaw: 'Static method: Buffer.from(array)', type: 'classMethod', name: 'from', signatures: [ @@ -181,7 +181,7 @@ const testData = [ params: [] } ], - textRaw: 'Class Method: `Fhqwhgads.again()`', + textRaw: 'Static method: `Fhqwhgads.again()`', type: 'classMethod' } ], diff --git a/test/fixtures/doc_with_backticks_in_headings.md b/test/fixtures/doc_with_backticks_in_headings.md index 74b4f3fd7ff39d..8b4fe5efaf4d37 100644 --- a/test/fixtures/doc_with_backticks_in_headings.md +++ b/test/fixtures/doc_with_backticks_in_headings.md @@ -8,6 +8,6 @@ ## Constructor: `new Fhqwhgads()` -## Class Method: `Fhqwhgads.again()` +## Static method: `Fhqwhgads.again()` ## `Fqhqwhgads.fullName` diff --git a/test/fixtures/order_of_end_tags_5873.md b/test/fixtures/order_of_end_tags_5873.md index 3eb7dadcb32b1a..888fe231802019 100644 --- a/test/fixtures/order_of_end_tags_5873.md +++ b/test/fixtures/order_of_end_tags_5873.md @@ -2,5 +2,5 @@ ## Subsection -### Class Method: Buffer.from(array) +### Static method: Buffer.from(array) * `array` {Array} diff --git a/tools/doc/json.js b/tools/doc/json.js index bcba923d907fb2..739a4f9f4fd3de 100644 --- a/tools/doc/json.js +++ b/tools/doc/json.js @@ -436,7 +436,7 @@ const r = String.raw; const eventPrefix = '^Event: +'; const classPrefix = '^[Cc]lass: +'; const ctorPrefix = '^(?:[Cc]onstructor: +)?`?new +'; -const classMethodPrefix = '^Class Method: +'; +const classMethodPrefix = '^Static method: +'; const maybeClassPropertyPrefix = '(?:Class Property: +)?'; const maybeQuote = '[\'"]?';