Skip to content

Commit

Permalink
doc: unambiguously mark deprecated signatures
Browse files Browse the repository at this point in the history
Currently, deprecation notices are always right between two function
signatures and it's virtually impossible to be certain whether they
refer to the previous signature or the next signature.

PR-URL: nodejs/node-addon-api#942
Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
  • Loading branch information
John French committed Mar 29, 2021
1 parent 56a9b57 commit 8224cb0
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/property_descriptor.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ The name of the property can be any of the following types:
- `napi_value value`
- `Napi::Name`

**This signature is deprecated. It will result in a memory leak if used.**
**The above signature is deprecated. It will result in a memory leak if used.**

```cpp
static Napi::PropertyDescriptor Napi::PropertyDescriptor::Accessor (
Expand Down Expand Up @@ -186,7 +186,7 @@ The name of the property can be any of the following types:
- `napi_value value`
- `Napi::Name`

**This signature is deprecated. It will result in a memory leak if used.**
**The above signature is deprecated. It will result in a memory leak if used.**

```cpp
static Napi::PropertyDescriptor Napi::PropertyDescriptor::Accessor (
Expand Down Expand Up @@ -236,7 +236,7 @@ The name of the property can be any of the following types:
- `napi_value value`
- `Napi::Name`

**This signature is deprecated. It will result in a memory leak if used.**
**The above signature is deprecated. It will result in a memory leak if used.**

```cpp
static Napi::PropertyDescriptor Napi::PropertyDescriptor::Function (
Expand Down

0 comments on commit 8224cb0

Please sign in to comment.