Commit 8c9f180
Gabriel Schulhof
doc: add inheritance links and other changes
* README.md:
* Change indentation to reflect class hierarchy.
* Link to new doc/hierarchy.md which shows full class hierarchy.
* Add single sentence with link to parent class at the top of class doc.
* doc/addon.md:
* Replace `Addon` with `Addon<T>`.
* Show templating in prototypes.
* Move `InstanceWrap<T>` method documentation to its own file, because
it is shared with `ObjectWRap<T>`, and link to said new file.
* doc/array.md: Create the file from the `Array`-related contents of
doc/basic_types.md.
* Remove doc/basic_types.md, splitting its contents per-class into
individual files.
* Add doc/hierarchy.md, with full class hierarchy.
* Add doc/instance_wrap.md for documenting `InstanceMethod`,
`InstanceAccessor`, and `InstanceValue`.
* Create doc/name.md from doc/basic_types.md, documenting `Napi::Name`.
* doc/object_wrap.md:
* Add templating notation `Napi::ObjectWrap<T>`.
* Show templating in prototypes.
* Wrap file to 80 columns.
* Remove methods provided by `InstanceWrap<T>` and link to
doc/instance_wrap.md.
* doc/value.md:
* Merge documentation from doc/basic_types.md.
* Add namespacing.
* Sort methods alphabetically.
Signed-off-by: Gabriel Schulhof <[email protected]>
Fixes: #796
PR-URL: #798
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Nicola Del Gobbo <[email protected]>1 parent 6562e6b commit 8c9f180
File tree
24 files changed
+989
-1337
lines changed- doc
24 files changed
+989
-1337
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
81 | 81 | | |
82 | 82 | | |
83 | 83 | | |
| 84 | + | |
84 | 85 | | |
85 | | - | |
86 | | - | |
87 | | - | |
88 | | - | |
89 | | - | |
90 | | - | |
91 | | - | |
92 | | - | |
93 | | - | |
| 86 | + | |
94 | 87 | | |
95 | | - | |
96 | 88 | | |
97 | 89 | | |
98 | | - | |
99 | | - | |
100 | | - | |
101 | | - | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
102 | 103 | | |
103 | 104 | | |
104 | | - | |
105 | | - | |
| 105 | + | |
| 106 | + | |
106 | 107 | | |
107 | 108 | | |
108 | 109 | | |
| |||
0 commit comments