From d84863ca7d480dd84d834bde1277d2f29cadb353 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Wed, 17 May 2017 17:16:37 -0400 Subject: [PATCH 1/2] 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. --- doc/api/n-api.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 423e71859dea94..b2a9dde8c14b30 100644 --- a/doc/api/n-api.md +++ b/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: +```C +#include + +``` + ## Basic N-API Data Types N-API exposes the following fundamental datatypes as abstractions that are From 767e35d57a6828a6a0a2eafa1ac81e3a96324a37 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Thu, 18 May 2017 21:22:20 -0400 Subject: [PATCH 2/2] squash: address comments --- doc/api/n-api.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index b2a9dde8c14b30..16806423aa739d 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -52,8 +52,10 @@ 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: +In order to use the N-API functions, include the file +[node_api.h](https://github.com/nodejs/node/blob/master/src/node_api.h) +which is located in the src directory in the node development tree. +For example: ```C #include