diff options
| author | Beth Griggs <Bethany.Griggs@uk.ibm.com> | 2017-05-08 10:36:41 +0100 |
|---|---|---|
| committer | Sam Roberts <vieuxtech@gmail.com> | 2017-05-11 11:09:06 -0700 |
| commit | abfd4bf9dfbf4e9817fe2c0b08476f505c4012d1 (patch) | |
| tree | 47e3675434d670eb9191bdc6154b313292114541 | |
| parent | 631cb42b4e2e067d82bd0c11b9317caf3b47e14a (diff) | |
| download | android-node-v8-abfd4bf9dfbf4e9817fe2c0b08476f505c4012d1.tar.gz android-node-v8-abfd4bf9dfbf4e9817fe2c0b08476f505c4012d1.tar.bz2 android-node-v8-abfd4bf9dfbf4e9817fe2c0b08476f505c4012d1.zip | |
doc: clarify node.js addons are c++
PR-URL: https://github.com/nodejs/node/pull/12898
Fixes: https://github.com/nodejs/node/issues/7129
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
| -rw-r--r-- | doc/api/_toc.md | 2 | ||||
| -rw-r--r-- | doc/api/addons.md | 6 | ||||
| -rw-r--r-- | doc/api/n-api.md | 2 |
3 files changed, 5 insertions, 5 deletions
diff --git a/doc/api/_toc.md b/doc/api/_toc.md index 32c7c7fa27..cc8b3a4ed0 100644 --- a/doc/api/_toc.md +++ b/doc/api/_toc.md @@ -7,7 +7,7 @@ * [Assertion Testing](assert.html) * [Buffer](buffer.html) -* [C/C++ Addons](addons.html) +* [C++ Addons](addons.html) * [C/C++ Addons - N-API](n-api.html) * [Child Processes](child_process.html) * [Cluster](cluster.html) diff --git a/doc/api/addons.md b/doc/api/addons.md index 9737d7f44e..1799cf7e5d 100644 --- a/doc/api/addons.md +++ b/doc/api/addons.md @@ -1,6 +1,6 @@ -# C/C++ Addons +# C++ Addons -Node.js Addons are dynamically-linked shared objects, written in C or C++, that +Node.js Addons are dynamically-linked shared objects, written in C++, that can be loaded into Node.js using the [`require()`][require] function, and used just as if they were an ordinary Node.js module. They are used primarily to provide an interface between JavaScript running in Node.js and C/C++ libraries. @@ -26,7 +26,7 @@ involving knowledge of several components and APIs : off-loading work via libuv to non-blocking system operations, worker threads or a custom use of libuv's threads. - - Internal Node.js libraries. Node.js itself exports a number of C/C++ APIs + - Internal Node.js libraries. Node.js itself exports a number of C++ APIs that Addons can use — the most important of which is the `node::ObjectWrap` class. diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 7530c0b1b4..348f2ad044 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -12,7 +12,7 @@ compiled for one version to run on later versions of Node.js without recompilation. Addons are built/packaged with the same approach/tools -outlined in the section titled [C/C++ Addons](addons.html). +outlined in the section titled [C++ Addons](addons.html). The only difference is the set of APIs that are used by the native code. Instead of using the V8 or [Native Abstractions for Node.js][] APIs, the functions available in the N-API are used. |