New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add reference to node_api.h in docs #13084

Closed
wants to merge 2 commits into
base: master
from

Conversation

Projects
None yet
7 participants
@mhdawson
Member

mhdawson commented May 17, 2017

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), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows [commit guidelines].
Affected core subsystem(s)

doc, n-api

doc: add reference to node_api.h in docs
Realized that we don't actually point people to the file to
include in order to access N-API functions.  Add that.
Show outdated Hide outdated doc/api/n-api.md
@@ -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:

This comment has been minimized.

@gibfahn

gibfahn May 18, 2017

Member

Maybe worth including a link to the file in Github:

https://github.com/nodejs/node/blob/master/src/node_api.h

@gibfahn

gibfahn May 18, 2017

Member

Maybe worth including a link to the file in Github:

https://github.com/nodejs/node/blob/master/src/node_api.h

@mhdawson

This comment has been minimized.

Show comment
Hide comment
@mhdawson

mhdawson May 19, 2017

Member

Pushed change to address comments

Member

mhdawson commented May 19, 2017

Pushed change to address comments

For example:
```C
#include <node_api.h>

This comment has been minimized.

@gibfahn

gibfahn May 19, 2017

Member

Extra newline (can be fixed as part of landing).

@gibfahn

gibfahn May 19, 2017

Member

Extra newline (can be fixed as part of landing).

@lpinca

lpinca approved these changes May 19, 2017

@mhdawson

This comment has been minimized.

Show comment
Hide comment
@mhdawson

This comment has been minimized.

Show comment
Hide comment
@mhdawson

mhdawson May 19, 2017

Member

CI good landing. Fixed nit and landed as 4a7b7e8

Member

mhdawson commented May 19, 2017

CI good landing. Fixed nit and landed as 4a7b7e8

@mhdawson mhdawson closed this May 19, 2017

mhdawson added a commit that referenced this pull request May 19, 2017

doc: add reference to node_api.h in docs
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 <cjihrig@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

@gibfahn gibfahn deleted the napi-doc2 branch May 20, 2017

@jasnell jasnell referenced this pull request May 28, 2017

Closed

8.0.0 Release Proposal #12220

@gibfahn gibfahn referenced this pull request Jun 15, 2017

Closed

Auditing for 6.11.1 #230

2 of 3 tasks complete

gabrielschulhof added a commit to gabrielschulhof/node that referenced this pull request Mar 12, 2018

doc: add reference to node_api.h in docs
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 <cjihrig@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

gabrielschulhof added a commit to gabrielschulhof/node that referenced this pull request Mar 31, 2018

doc: add reference to node_api.h in docs
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 <cjihrig@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

gabrielschulhof added a commit to gabrielschulhof/node that referenced this pull request Apr 10, 2018

doc: add reference to node_api.h in docs
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 <cjihrig@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

MylesBorins added a commit that referenced this pull request Apr 16, 2018

doc: add reference to node_api.h in docs
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 <cjihrig@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

@MylesBorins MylesBorins referenced this pull request Apr 16, 2018

Merged

v6.14.2 proposal #19996

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment