Skip to content

Commit 8c9f180

Browse files
author
Gabriel Schulhof
committed
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

24 files changed

+989
-1337
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -81,28 +81,29 @@ The oldest Node.js version supported by the current version of node-addon-api is
8181

8282
The following is the documentation for node-addon-api.
8383

84+
- [Full Class Hierarchy](doc/hierarchy.md)
8485
- [Addon Structure](doc/addon.md)
85-
- [Basic Types](doc/basic_types.md)
86-
- [Array](doc/basic_types.md#array)
87-
- [Symbol](doc/symbol.md)
88-
- [String](doc/string.md)
89-
- [Name](doc/basic_types.md#name)
90-
- [Number](doc/number.md)
91-
- [Date](doc/date.md)
92-
- [BigInt](doc/bigint.md)
93-
- [Boolean](doc/boolean.md)
86+
- Basic Types:
9487
- [Env](doc/env.md)
95-
- [Value](doc/value.md)
9688
- [CallbackInfo](doc/callbackinfo.md)
9789
- [Reference](doc/reference.md)
98-
- [External](doc/external.md)
99-
- [Object](doc/object.md)
100-
- [ObjectReference](doc/object_reference.md)
101-
- [PropertyDescriptor](doc/property_descriptor.md)
90+
- [Value](doc/value.md)
91+
- [Name](doc/name.md)
92+
- [Symbol](doc/symbol.md)
93+
- [String](doc/string.md)
94+
- [Number](doc/number.md)
95+
- [Date](doc/date.md)
96+
- [BigInt](doc/bigint.md)
97+
- [Boolean](doc/boolean.md)
98+
- [External](doc/external.md)
99+
- [Object](doc/object.md)
100+
- [Array](doc/array.md)
101+
- [ObjectReference](doc/object_reference.md)
102+
- [PropertyDescriptor](doc/property_descriptor.md)
102103
- [Error Handling](doc/error_handling.md)
103104
- [Error](doc/error.md)
104-
- [TypeError](doc/type_error.md)
105-
- [RangeError](doc/range_error.md)
105+
- [TypeError](doc/type_error.md)
106+
- [RangeError](doc/range_error.md)
106107
- [Object Lifetime Management](doc/object_lifetime_management.md)
107108
- [HandleScope](doc/handle_scope.md)
108109
- [EscapableHandleScope](doc/escapable_handle_scope.md)

0 commit comments

Comments
 (0)