Skip to content

Commit 87d0fd8

Browse files
tniessenMylesBorins
authored andcommittedMay 1, 2018
doc: mark NAPI_AUTO_LENGTH as code
Backport-PR-URL: #19265 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 58688d9 commit 87d0fd8

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.
@@ -1260,7 +1260,7 @@ napi_status napi_create_function(napi_env env,
12601260
- `[in] utf8name`: A string representing the name of the function encoded as
12611261
UTF8.
12621262
- `[in] length`: The length of the utf8name in bytes, or
1263-
NAPI_AUTO_LENGTH if it is null-terminated.
1263+
`NAPI_AUTO_LENGTH` if it is null-terminated.
12641264
- `[in] cb`: A function pointer to the native function to be invoked when the
12651265
created function is invoked from JavaScript.
12661266
- `[in] data`: Optional arbitrary context data to be passed into the native
@@ -1493,7 +1493,7 @@ napi_status napi_create_string_latin1(napi_env env,
14931493
- `[in] env`: The environment that the API is invoked under.
14941494
- `[in] str`: Character buffer representing a ISO-8859-1-encoded string.
14951495
- `[in] length`: The length of the string in bytes, or
1496-
NAPI_AUTO_LENGTH if it is null-terminated.
1496+
`NAPI_AUTO_LENGTH` if it is null-terminated.
14971497
- `[out] result`: A `napi_value` representing a JavaScript String.
14981498

14991499
Returns `napi_ok` if the API succeeded.
@@ -1518,7 +1518,7 @@ napi_status napi_create_string_utf16(napi_env env,
15181518
- `[in] env`: The environment that the API is invoked under.
15191519
- `[in] str`: Character buffer representing a UTF16-LE-encoded string.
15201520
- `[in] length`: The length of the string in two-byte code units, or
1521-
NAPI_AUTO_LENGTH if it is null-terminated.
1521+
`NAPI_AUTO_LENGTH` if it is null-terminated.
15221522
- `[out] result`: A `napi_value` representing a JavaScript String.
15231523

15241524
Returns `napi_ok` if the API succeeded.
@@ -1542,7 +1542,7 @@ napi_status napi_create_string_utf8(napi_env env,
15421542

15431543
- `[in] env`: The environment that the API is invoked under.
15441544
- `[in] str`: Character buffer representing a UTF8-encoded string.
1545-
- `[in] length`: The length of the string in bytes, or NAPI_AUTO_LENGTH
1545+
- `[in] length`: The length of the string in bytes, or `NAPI_AUTO_LENGTH`
15461546
if it is null-terminated.
15471547
- `[out] result`: A `napi_value` representing a JavaScript String.
15481548

@@ -3068,7 +3068,7 @@ napi_status napi_define_class(napi_env env,
30683068
- `[in] utf8name`: Name of the JavaScript constructor function; this is
30693069
not required to be the same as the C++ class name, though it is recommended
30703070
for clarity.
3071-
- `[in] length`: The length of the utf8name in bytes, or NAPI_AUTO_LENGTH
3071+
- `[in] length`: The length of the utf8name in bytes, or `NAPI_AUTO_LENGTH`
30723072
if it is null-terminated.
30733073
- `[in] constructor`: Callback function that handles constructing instances
30743074
of the class. (This should be a static method on the class, not an actual

0 commit comments

Comments
 (0)
Please sign in to comment.