Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Schonning <nschonni@gmail.com>2019-09-13 07:22:29 +0300
committerRich Trott <rtrott@gmail.com>2019-09-16 21:24:54 +0300
commite2dcbf1c3231513c38151d729f180a54ea902da9 (patch)
tree1f9197fb7c0af601c310a179ba089fdac8d6d5b5 /doc/api/addons.md
parent3d841fe20d732111094c3f62febd5a6b8b483b91 (diff)
doc: use consistent unordered list style
Convert to asterisks when there are mixed styles in document. Addresses Markdownlint MD004 rule PR-URL: https://github.com/nodejs/node/pull/29516 Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc/api/addons.md')
-rw-r--r--doc/api/addons.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/api/addons.md b/doc/api/addons.md
index 81bd8b5bacc..ca99e5e35d9 100644
--- a/doc/api/addons.md
+++ b/doc/api/addons.md
@@ -17,13 +17,13 @@ for more information on N-API.
When not using N-API, implementing Addons is complicated,
involving knowledge of several components and APIs:
-- V8: the C++ library Node.js currently uses to provide the
+* V8: the C++ library Node.js currently uses to provide the
JavaScript implementation. V8 provides the mechanisms for creating objects,
calling functions, etc. V8's API is documented mostly in the
`v8.h` header file (`deps/v8/include/v8.h` in the Node.js source
tree), which is also available [online][v8-docs].
-- [libuv][]: The C library that implements the Node.js event loop, its worker
+* [libuv][]: The C library that implements the Node.js event loop, its worker
threads and all of the asynchronous behaviors of the platform. It also
serves as a cross-platform abstraction library, giving easy, POSIX-like
access across all major operating systems to many common system tasks, such
@@ -35,11 +35,11 @@ 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++ APIs
+* Internal Node.js libraries. Node.js itself exports a number of C++ APIs
that Addons can use &mdash; the most important of which is the
`node::ObjectWrap` class.
-- Node.js includes a number of other statically linked libraries including
+* Node.js includes a number of other statically linked libraries including
OpenSSL. These other libraries are located in the `deps/` directory in the
Node.js source tree. Only the libuv, OpenSSL, V8 and zlib symbols are
purposefully re-exported by Node.js and may be used to various extents by
@@ -262,8 +262,8 @@ signature.
In order to be loaded from multiple Node.js environments,
such as a main thread and a Worker thread, an add-on needs to either:
-- Be an N-API addon, or
-- Be declared as context-aware using `NODE_MODULE_INIT()` as described above
+* Be an N-API addon, or
+* Be declared as context-aware using `NODE_MODULE_INIT()` as described above
### Building