summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Dawson <michael_dawson@ca.ibm.com>2020-04-08 16:17:37 -0400
committerMichael Dawson <michael_dawson@ca.ibm.com>2020-04-16 17:12:37 -0400
commit5a4f24e7e1d96af39a75c70eaacb14e28fed5341 (patch)
treed9712309793398a1fa44b99b5f83dccf1d6dda68
parent6d77df840c4a38a95d8218322b6e92ee5cf3a7b2 (diff)
downloadnode-new-5a4f24e7e1d96af39a75c70eaacb14e28fed5341.tar.gz
doc: improve consistency in usage of NULL
- add backticks around use of NULL - convert from null to NULL where we mean NULL Signed-off-by: Michael Dawson <michael_dawson@ca.ibm.com> PR-URL: https://github.com/nodejs/node/pull/32726 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Christopher Hiller <boneskull@boneskull.com>
-rw-r--r--doc/api/n-api.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/api/n-api.md b/doc/api/n-api.md
index a38ebbd6f8..71796504b1 100644
--- a/doc/api/n-api.md
+++ b/doc/api/n-api.md
@@ -860,7 +860,7 @@ SemVer applying. In order to support this model with N-API, both
in internal functionality and for module specific functionality
(as its good practice), the `throw_` and `create_` functions
take an optional code parameter which is the string for the code
-to be added to the error object. If the optional parameter is NULL
+to be added to the error object. If the optional parameter is `NULL`
then no code will be associated with the error. If a code is provided,
the name associated with the error is also updated to be:
@@ -1058,7 +1058,7 @@ napi_status napi_get_and_clear_last_exception(napi_env env,
```
* `[in] env`: The environment that the API is invoked under.
-* `[out] result`: The exception if one is pending, NULL otherwise.
+* `[out] result`: The exception if one is pending, `NULL` otherwise.
Returns `napi_ok` if the API succeeded.
@@ -1350,7 +1350,7 @@ then be modified through [`napi_reference_ref`][] and
[`napi_reference_unref`][]. If an object is collected while the count
for a reference is 0, all subsequent calls to
get the object associated with the reference [`napi_get_reference_value`][]
-will return NULL for the returned `napi_value`. An attempt to call
+will return `NULL` for the returned `napi_value`. An attempt to call
[`napi_reference_ref`][] for a reference whose object has been collected
will result in an error.
@@ -1473,7 +1473,7 @@ Returns `napi_ok` if the API succeeded.
If still valid, this API returns the `napi_value` representing the
JavaScript `Object` associated with the `napi_ref`. Otherwise, result
-will be NULL.
+will be `NULL`.
### Cleanup on exit of the current Node.js instance
@@ -1549,7 +1549,7 @@ napi_value Init(napi_env env, napi_value exports);
The return value from `Init` is treated as the `exports` object for the module.
The `Init` method is passed an empty object via the `exports` parameter as a
-convenience. If `Init` returns NULL, the parameter passed as `exports` is
+convenience. If `Init` returns `NULL`, the parameter passed as `exports` is
exported by the module. N-API modules cannot modify the `module` object but can
specify anything as the `exports` property of the module.
@@ -2827,7 +2827,7 @@ napi_status napi_get_value_string_latin1(napi_env env,
* `[in] env`: The environment that the API is invoked under.
* `[in] value`: `napi_value` representing JavaScript string.
-* `[in] buf`: Buffer to write the ISO-8859-1-encoded string into. If NULL is
+* `[in] buf`: Buffer to write the ISO-8859-1-encoded string into. If `NULL` is
passed in, the length of the string (in bytes) is returned.
* `[in] bufsize`: Size of the destination buffer. When this value is
insufficient, the returned string will be truncated.
@@ -2856,7 +2856,7 @@ napi_status napi_get_value_string_utf8(napi_env env,
* `[in] env`: The environment that the API is invoked under.
* `[in] value`: `napi_value` representing JavaScript string.
-* `[in] buf`: Buffer to write the UTF8-encoded string into. If NULL is passed
+* `[in] buf`: Buffer to write the UTF8-encoded string into. If `NULL` is passed
in, the length of the string (in bytes) is returned.
* `[in] bufsize`: Size of the destination buffer. When this value is
insufficient, the returned string will be truncated.
@@ -2884,7 +2884,7 @@ napi_status napi_get_value_string_utf16(napi_env env,
* `[in] env`: The environment that the API is invoked under.
* `[in] value`: `napi_value` representing JavaScript string.
-* `[in] buf`: Buffer to write the UTF16-LE-encoded string into. If NULL is
+* `[in] buf`: Buffer to write the UTF16-LE-encoded string into. If `NULL` is
passed in, the length of the string (in 2-byte code units) is returned.
* `[in] bufsize`: Size of the destination buffer. When this value is
insufficient, the returned string will be truncated.