FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: fix up N-API doc by mhdawson · Pull Request #30254 · nodejs/node · GitHub

/ node Public

doc: fix up N-API doc - #30254

Closed
mhdawson wants to merge 2 commits into
nodejs:masterfrom
mhdawson:napi-doc-vers
ConversationCommits (2)ChecksFiles changed
Closed

doc: fix up N-API doc#30254
mhdawson wants to merge 2 commits into
nodejs:masterfrom
mhdawson:napi-doc-vers

Conversation

mhdawson commented Nov 4, 2019

Copy link
Copy Markdown
Member
  • Add missing N-API version info
  • Fix N-API version info for napi_extended_error_info
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

doc: fix up N-API doc
eacb8a1 
* Add missing N-API version info
* Fix N-API version info for napi_extended_error_info
nodejs-github-bot added doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API. labels Nov 4, 2019

mhdawson commented Nov 4, 2019

Copy link
Copy Markdown
Member Author

@NickNaso let me know if I missed anything.

NickNaso reviewed Nov 4, 2019
View reviewed changes

NickNaso left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@mhdawson I think that you missed only napi_add_finalizer it's added in Node.js version 8.0.0 but it's promoted as stable in N-API version 5.

NickNaso commented Nov 4, 2019

Copy link
Copy Markdown
Member

@mhdawson I found some other inconsistencies that I report below:

  • Signature for napi_create_reference in documentation is:
NAPI_EXTERN napi_status napi_create_reference(napi_env env,
                                              napi_value value,
                                              int initial_refcount,
                                              napi_ref* result);

instead it should be:

NAPI_EXTERN napi_status napi_create_reference(napi_env env,
                                              napi_value value,
                                              uint32_t initial_refcount,
                                              napi_ref* result);
  • Signature for napi_reference_ref in documentations is:
NAPI_EXTERN napi_status napi_reference_ref(napi_env env,
                                           napi_ref ref,
                                           int* result);

instead it should be:

NAPI_EXTERN napi_status napi_reference_ref(napi_env env,
                                           napi_ref ref,
                                           uint32_t* result);
  • Signature for napi_reference_unref in documentation is:
NAPI_EXTERN napi_status napi_reference_unref(napi_env env,
                                             napi_ref ref,
                                             uint32_t* result);
  • Signature for napi_call_function in documentations is:
napi_status napi_call_function(napi_env env,
                               napi_value recv,
                               napi_value func,
                               int argc,
                               const napi_value* argv,
                               napi_value* result)

instead it should be:

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);
  • Signature for napi_make_callback in documentations is:
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)

instead it should be:

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);

I think that we could avoid to open other PR and handle the necessary changes in this one.

BridgeAR approved these changes Nov 5, 2019
View reviewed changes

BridgeAR left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

RSLGTM

mhdawson commented Nov 6, 2019 •
edited
Loading

Copy link
Copy Markdown
Member Author

@NickNaso thanks I'll look at the non-version related inconsistencies separately.

EDIT, I see the comment above, will integrate into this PR.

mhdawson commented Nov 6, 2019

Copy link
Copy Markdown
Member Author

@NickNaso napi_add_finalizer was already tagged as version 5 that is why it does not show up in the diffs.

mhdawson commented Nov 6, 2019

Copy link
Copy Markdown
Member Author

@NickNaso addressed the rest of the comments

NickNaso approved these changes Nov 7, 2019
View reviewed changes

NickNaso left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM

mhdawson added the author ready PRs that have at least one approval, no outstanding review comments, and a CI started. label Nov 7, 2019

mhdawson commented Nov 7, 2019

Copy link
Copy Markdown
Member Author

Lite CI run: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/4032/

trivikr pushed a commit that referenced this pull request Nov 13, 2019
doc: fix up N-API doc
1e0679e 
* 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>

trivikr commented Nov 13, 2019

Copy link
Copy Markdown
Member

Landed in 1e0679e

trivikr closed this Nov 13, 2019
MylesBorins pushed a commit that referenced this pull request Nov 17, 2019
doc: fix up N-API doc
b8afe57 
* 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>
BridgeAR mentioned this pull request Nov 19, 2019
Merged
targos pushed a commit that referenced this pull request Dec 1, 2019
doc: fix up N-API doc
8274875 
* 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>
BethGriggs mentioned this pull request Dec 9, 2019
Closed
MylesBorins pushed a commit that referenced this pull request Dec 17, 2019
doc: fix up N-API doc
b8b6f25 
* 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>
BethGriggs mentioned this pull request Dec 23, 2019
Merged
mhdawson deleted the napi-doc-vers branch September 14, 2020 21:19
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

lpinca lpinca approved these changes
gengjiawen gengjiawen approved these changes
BridgeAR BridgeAR approved these changes
+1 more reviewer
NickNaso NickNaso approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no outstanding review comments, and a CI started. doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

Back | FazBrowse Home | New Git URL