Skip to content

Commit b5073a0

Browse files
tniessenMylesBorins
authored andcommitted
doc: mark NAPI_AUTO_LENGTH as code
PR-URL: #18697 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 72d7159 commit b5073a0

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

doc/api/n-api.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -554,10 +554,10 @@ NAPI_NO_RETURN void napi_fatal_error(const char* location,
554554

555555
- `[in] location`: Optional location at which the error occurred.
556556
- `[in] location_len`: The length of the location in bytes, or
557-
NAPI_AUTO_LENGTH if it is null-terminated.
557+
`NAPI_AUTO_LENGTH` if it is null-terminated.
558558
- `[in] message`: The message associated with the error.
559559
- `[in] message_len`: The length of the message in bytes, or
560-
NAPI_AUTO_LENGTH if it is
560+
`NAPI_AUTO_LENGTH` if it is
561561
null-terminated.
562562

563563
The function call does not return, the process will be terminated.
@@ -1255,7 +1255,7 @@ napi_status napi_create_function(napi_env env,
12551255
- `[in] utf8name`: A string representing the name of the function encoded as
12561256
UTF8.
12571257
- `[in] length`: The length of the utf8name in bytes, or
1258-
NAPI_AUTO_LENGTH if it is null-terminated.
1258+
`NAPI_AUTO_LENGTH` if it is null-terminated.
12591259
- `[in] cb`: A function pointer to the native function to be invoked when the
12601260
created function is invoked from JavaScript.
12611261
- `[in] data`: Optional arbitrary context data to be passed into the native
@@ -1483,7 +1483,7 @@ napi_status napi_create_string_latin1(napi_env env,
14831483
- `[in] env`: The environment that the API is invoked under.
14841484
- `[in] str`: Character buffer representing a ISO-8859-1-encoded string.
14851485
- `[in] length`: The length of the string in bytes, or
1486-
NAPI_AUTO_LENGTH if it is null-terminated.
1486+
`NAPI_AUTO_LENGTH` if it is null-terminated.
14871487
- `[out] result`: A `napi_value` representing a JavaScript String.
14881488

14891489
Returns `napi_ok` if the API succeeded.
@@ -1507,7 +1507,7 @@ napi_status napi_create_string_utf16(napi_env env,
15071507
- `[in] env`: The environment that the API is invoked under.
15081508
- `[in] str`: Character buffer representing a UTF16-LE-encoded string.
15091509
- `[in] length`: The length of the string in two-byte code units, or
1510-
NAPI_AUTO_LENGTH if it is null-terminated.
1510+
`NAPI_AUTO_LENGTH` if it is null-terminated.
15111511
- `[out] result`: A `napi_value` representing a JavaScript String.
15121512

15131513
Returns `napi_ok` if the API succeeded.
@@ -1530,7 +1530,7 @@ napi_status napi_create_string_utf8(napi_env env,
15301530

15311531
- `[in] env`: The environment that the API is invoked under.
15321532
- `[in] str`: Character buffer representing a UTF8-encoded string.
1533-
- `[in] length`: The length of the string in bytes, or NAPI_AUTO_LENGTH
1533+
- `[in] length`: The length of the string in bytes, or `NAPI_AUTO_LENGTH`
15341534
if it is null-terminated.
15351535
- `[out] result`: A `napi_value` representing a JavaScript String.
15361536

@@ -3053,7 +3053,7 @@ napi_status napi_define_class(napi_env env,
30533053
- `[in] utf8name`: Name of the JavaScript constructor function; this is
30543054
not required to be the same as the C++ class name, though it is recommended
30553055
for clarity.
3056-
- `[in] length`: The length of the utf8name in bytes, or NAPI_AUTO_LENGTH
3056+
- `[in] length`: The length of the utf8name in bytes, or `NAPI_AUTO_LENGTH`
30573057
if it is null-terminated.
30583058
- `[in] constructor`: Callback function that handles constructing instances
30593059
of the class. (This should be a static method on the class, not an actual

0 commit comments

Comments
 (0)