Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Redundancy in documentation of Napi::Value #796

Closed
gabrielschulhof opened this issue Aug 24, 2020 · 1 comment
Closed

Redundancy in documentation of Napi::Value #796

gabrielschulhof opened this issue Aug 24, 2020 · 1 comment

Comments

@gabrielschulhof
Copy link
Contributor

gabrielschulhof commented Aug 24, 2020 •
edited
Loading

We have doc/basic_types.md#value and doc/value.md. Do we need both?
@gabrielschulhof
Copy link
Contributor Author

gabrielschulhof commented Aug 24, 2020 •
edited
Loading

Meeting conclusion: separate out pieces of basic_types.md.

gabrielschulhof pushed a commit to gabrielschulhof/node-addon-api that referenced this issue Aug 29, 2020
doc: add inheritance links and other changes
60c2acf 
* 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: nodejs#796
@NickNaso NickNaso mentioned this issue Sep 10, 2020
Closed
6 tasks
Superlokkus pushed a commit to Superlokkus/node-addon-api that referenced this issue Nov 20, 2020
@Superlokkus
doc: add inheritance links and other changes
772d964 
* 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: nodejs#796
PR-URL: nodejs#798
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Nicola Del Gobbo <[email protected]>
kevindavies8 added a commit to kevindavies8/node-addon-api-Develop that referenced this issue Aug 24, 2022
@kevindavies8
doc: add inheritance links and other changes
d138c6b 
* 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: nodejs/node-addon-api#796
PR-URL: nodejs/node-addon-api#798
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Nicola Del Gobbo <[email protected]>
Marlyfleitas added a commit to Marlyfleitas/node-api-addon-Development that referenced this issue Aug 26, 2022
@Marlyfleitas
doc: add inheritance links and other changes
e15bc21 
* 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: nodejs/node-addon-api#796
PR-URL: nodejs/node-addon-api#798
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Nicola Del Gobbo <[email protected]>
wroy7860 added a commit to wroy7860/addon-api-benchmark-node that referenced this issue Sep 19, 2022
@wroy7860
doc: add inheritance links and other changes
703c00b 
* 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: nodejs/node-addon-api#796
PR-URL: nodejs/node-addon-api#798
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Nicola Del Gobbo <[email protected]>
johnfrench3 pushed a commit to johnfrench3/node-addon-api-git that referenced this issue Aug 11, 2023
doc: add inheritance links and other changes
16b074c 
* 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: nodejs/node-addon-api#796
PR-URL: nodejs/node-addon-api#798
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Nicola Del Gobbo <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@gabrielschulhof