Skip to content

Commit b62dc80

Browse files
authored
Set up doc-comments and doxygen (#34)
- Add doc-comments to a few of the classes in napi.h - Add a doxygen config file
1 parent 9d46bcb commit b62dc80

File tree

4 files changed

+2656
-163
lines changed

4 files changed

+2656
-163
lines changed

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@ Node.js API (N-API), along with library code that enables
55
backward-compatibility with use with older versions of Node.js that do
66
not have N-API built-in.
77

8+
### API Documentation
9+
10+
- [ABI-Stable C APIs in Node.js](https://nodejs.org/api/n-api.html)
11+
- [C++ APIs in this package](https://nodejs.github.io/node-api/namespace_napi.html)
12+
13+
### Getting Started
14+
815
To use N-API in a native module:
916
1. Add a dependency on this package to `package.json`:
1017
```json
@@ -41,21 +48,16 @@ To use N-API in a native module:
4148
At build time, the N-API back-compat library code will be used only when the
4249
targeted node version *does not* have N-API built-in.
4350

44-
See the [main project README](
45-
https://github.com/nodejs/abi-stable-node/blob/doc/README.md)
46-
or [preliminary documentation](https://github.com/nodejs/node/blob/v8.x/doc/api/n-api.md)
47-
for more details about N-API.
48-
4951
<a name="collaborators"></a>
5052
### WG Members / Collaborators
51-
| Name | GitHub link |
52-
| ------------------- | ------------------------------------------------------ |
53-
| Anna Henningsen | [@addaleax](https://github.com/addaleax) |
54-
| Arunesh Chandra | [@aruneshchandra](https://github.com/aruneshchandra) |
55-
| Benjamin Byholm | [@kkoopa](https://github.com/kkoopa) |
56-
| Gabriel Schulhof | [@gabrielschulhof](https://github.com/gabrielschulhof) |
57-
| Hitesh Kanwathirtha | [@digitalinfinity](https://github.com/digitalinfinity) |
58-
| Jason Ginchereau | [@jasongin](https://github.com/jasongin) |
59-
| Michael Dawson | [@mhdawson](https://github.com/mhdawson) |
60-
| Sampson Gao | [@sampsongao](https://github.com/sampsongao) |
61-
| Taylor Woll | [@boingoing](https://github.com/boingoing) |
53+
| Name | GitHub link |
54+
| ------------------- | ----------------------------------------------------- |
55+
| Anna Henningsen | [addaleax](https://github.com/addaleax) |
56+
| Arunesh Chandra | [aruneshchandra](https://github.com/aruneshchandra) |
57+
| Benjamin Byholm | [kkoopa](https://github.com/kkoopa) |
58+
| Gabriel Schulhof | [gabrielschulhof](https://github.com/gabrielschulhof) |
59+
| Hitesh Kanwathirtha | [digitalinfinity](https://github.com/digitalinfinity) |
60+
| Jason Ginchereau | [jasongin](https://github.com/jasongin) |
61+
| Michael Dawson | [mhdawson](https://github.com/mhdawson) |
62+
| Sampson Gao | [sampsongao](https://github.com/sampsongao) |
63+
| Taylor Woll | [boingoing](https://github.com/boingoing) |

doc/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/html

0 commit comments

Comments
 (0)