Skip to content

Commit

Permalink
doc: fix up N-API doc
Browse files Browse the repository at this point in the history
* Add missing N-API version info
* Fix N-API version info for napi_extended_error_info

PR-URL: #30254
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
  • Loading branch information
mhdawson authored and trivikr committed Nov 13, 2019
1 parent 3d92689 commit 1e0679e
Showing 1 changed file with 22 additions and 18 deletions.
40 changes: 22 additions & 18 deletions doc/api/n-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -729,8 +729,8 @@ is provided which returns a `napi_extended_error_info` structure.
The format of the `napi_extended_error_info` structure is as follows:

<!-- YAML
added: v10.6.0
napiVersion: 4
added: v8.0.0
napiVersion: 1
-->

```C
Expand Down Expand Up @@ -1369,7 +1369,7 @@ napiVersion: 1
```C
NAPI_EXTERN napi_status napi_create_reference(napi_env env,
napi_value value,
int initial_refcount,
uint32_t initial_refcount,
napi_ref* result);
```

Expand Down Expand Up @@ -1412,7 +1412,7 @@ napiVersion: 1
```C
NAPI_EXTERN napi_status napi_reference_ref(napi_env env,
napi_ref ref,
int* result);
uint32_t* result);
```

* `[in] env`: The environment that the API is invoked under.
Expand All @@ -1433,7 +1433,7 @@ napiVersion: 1
```C
NAPI_EXTERN napi_status napi_reference_unref(napi_env env,
napi_ref ref,
int* result);
uint32_t* result););
```

* `[in] env`: The environment that the API is invoked under.
Expand Down Expand Up @@ -1840,6 +1840,7 @@ structure, in most cases using a `TypedArray` will suffice.
#### napi_create_date
<!-- YAML
added: v11.11.0
napiVersion: 5
-->

```C
Expand Down Expand Up @@ -2519,6 +2520,7 @@ This API returns various properties of a `DataView`.
#### napi_get_date_value
<!-- YAML
added: v11.11.0
napiVersion: 5
-->

```C
Expand Down Expand Up @@ -3139,6 +3141,7 @@ This API checks if the `Object` passed in is a buffer.
### napi_is_date
<!-- YAML
added: v11.11.0
napiVersion: 5
-->

```C
Expand Down Expand Up @@ -3829,12 +3832,12 @@ napiVersion: 1
-->

```C
napi_status napi_call_function(napi_env env,
napi_value recv,
napi_value func,
int argc,
const napi_value* argv,
napi_value* result)
NAPI_EXTERN napi_status napi_call_function(napi_env env,
napi_value recv,
napi_value func,
size_t argc,
const napi_value* argv,
napi_value* result);
```

* `[in] env`: The environment that the API is invoked under.
Expand Down Expand Up @@ -4299,6 +4302,7 @@ JavaScript object becomes garbage-collected.

<!-- YAML
added: v8.0.0
napiVersion: 5
-->

```C
Expand Down Expand Up @@ -4565,13 +4569,13 @@ changes:
-->

```C
napi_status napi_make_callback(napi_env env,
napi_async_context async_context,
napi_value recv,
napi_value func,
int argc,
const napi_value* argv,
napi_value* result)
NAPI_EXTERN napi_status napi_make_callback(napi_env env,
napi_async_context async_context,
napi_value recv,
napi_value func,
size_t argc,
const napi_value* argv,
napi_value* result);
```

* `[in] env`: The environment that the API is invoked under.
Expand Down

0 comments on commit 1e0679e

Please sign in to comment.