Skip to content

Commit

Permalink
doc: improve consistency in usage of NULL
Browse files Browse the repository at this point in the history
- add backticks around use of NULL
- convert from null to NULL where we mean
  NULL

Signed-off-by: Michael Dawson <[email protected]>

PR-URL: #32726
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Christopher Hiller <[email protected]>
  • Loading branch information
mhdawson committed Apr 16, 2020
1 parent 6d77df8 commit 5a4f24e
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions doc/api/n-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 5a4f24e

Please sign in to comment.