doc: add reference to node_api.h in docs #13084
Closed
Conversation
This file contains 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
Realized that we don't actually point people to the file to include in order to access N-API functions. Add that.
nodejs-github-bot
added
doc
cjihrig
approved these changes
May 18, 2017
gibfahn
reviewed
May 18, 2017
doc/api/n-api.md
Outdated
| @@ -52,6 +52,13 @@ for the N-API C based functions exported by Node.js. These wrappers are not | |||
| part of N-API, nor will they be maintained as part of Node.js. One such | |||
| example is: [node-api](https://github.com/nodejs/node-api). | |||
|
|
|||
| In order to use the N-API functions, include the file "node_api.h" which | |||
| is located in the src directory in the node development tree. For example: | |||
There was a problem hiding this comment.
Maybe worth including a link to the file in Github:
https://github.com/nodejs/node/blob/master/src/node_api.h
|
Pushed change to address comments |
gibfahn
approved these changes
May 19, 2017
gibfahn
reviewed
May 19, 2017
| For example: | ||
| ```C | ||
| #include <node_api.h> | ||
|
|
There was a problem hiding this comment.
Extra newline (can be fixed as part of landing).
lpinca
approved these changes
May 19, 2017
addaleax
approved these changes
May 19, 2017
|
CI good landing. Fixed nit and landed as 4a7b7e8 |
mhdawson
added a commit
that referenced
this pull request
May 19, 2017
Realized that we don't actually point people to the file to include in order to access N-API functions. Add that. PR-URL: #13084 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
3 tasks
gabrielschulhof
pushed a commit
to gabrielschulhof/node
that referenced
this pull request
Apr 10, 2018
Realized that we don't actually point people to the file to include in order to access N-API functions. Add that. PR-URL: nodejs#13084 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
MylesBorins
pushed a commit
that referenced
this pull request
Apr 16, 2018
Realized that we don't actually point people to the file to include in order to access N-API functions. Add that. Backport-PR-URL: #19447 PR-URL: #13084 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Realized that we don't actually point people to the file to
include in order to access N-API functions. Add that.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
doc, n-api