Commit b5073a0
doc: mark NAPI_AUTO_LENGTH as code
PR-URL: #18697
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>1 parent 72d7159 commit b5073a0
1 file changed
Lines changed: 7 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -554,10 +554,10 @@ NAPI_NO_RETURN void napi_fatal_error(const char* location, | |||
| 554 | 554 | ||
| 555 | 555 | - `[in] location`: Optional location at which the error occurred. | |
| 556 | 556 | - `[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. | ||
| 558 | 558 | - `[in] message`: The message associated with the error. | |
| 559 | 559 | - `[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 | ||
| 561 | 561 | null-terminated. | |
| 562 | 562 | ||
| 563 | 563 | The function call does not return, the process will be terminated. | |
@@ -1255,7 +1255,7 @@ napi_status napi_create_function(napi_env env, | |||
| 1255 | 1255 | - `[in] utf8name`: A string representing the name of the function encoded as | |
| 1256 | 1256 | UTF8. | |
| 1257 | 1257 | - `[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. | ||
| 1259 | 1259 | - `[in] cb`: A function pointer to the native function to be invoked when the | |
| 1260 | 1260 | created function is invoked from JavaScript. | |
| 1261 | 1261 | - `[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, | |||
| 1483 | 1483 | - `[in] env`: The environment that the API is invoked under. | |
| 1484 | 1484 | - `[in] str`: Character buffer representing a ISO-8859-1-encoded string. | |
| 1485 | 1485 | - `[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. | ||
| 1487 | 1487 | - `[out] result`: A `napi_value` representing a JavaScript String. | |
| 1488 | 1488 | ||
| 1489 | 1489 | Returns `napi_ok` if the API succeeded. | |
@@ -1507,7 +1507,7 @@ napi_status napi_create_string_utf16(napi_env env, | |||
| 1507 | 1507 | - `[in] env`: The environment that the API is invoked under. | |
| 1508 | 1508 | - `[in] str`: Character buffer representing a UTF16-LE-encoded string. | |
| 1509 | 1509 | - `[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. | ||
| 1511 | 1511 | - `[out] result`: A `napi_value` representing a JavaScript String. | |
| 1512 | 1512 | ||
| 1513 | 1513 | Returns `napi_ok` if the API succeeded. | |
@@ -1530,7 +1530,7 @@ napi_status napi_create_string_utf8(napi_env env, | |||
| 1530 | 1530 | ||
| 1531 | 1531 | - `[in] env`: The environment that the API is invoked under. | |
| 1532 | 1532 | - `[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` | ||
| 1534 | 1534 | if it is null-terminated. | |
| 1535 | 1535 | - `[out] result`: A `napi_value` representing a JavaScript String. | |
| 1536 | 1536 | ||
@@ -3053,7 +3053,7 @@ napi_status napi_define_class(napi_env env, | |||
| 3053 | 3053 | - `[in] utf8name`: Name of the JavaScript constructor function; this is | |
| 3054 | 3054 | not required to be the same as the C++ class name, though it is recommended | |
| 3055 | 3055 | 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` | ||
| 3057 | 3057 | if it is null-terminated. | |
| 3058 | 3058 | - `[in] constructor`: Callback function that handles constructing instances | |
| 3059 | 3059 | of the class. (This should be a static method on the class, not an actual | |
0 commit comments