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

Incorrect N-API documentation for some functions accepting strings #13555

Closed
RReverser opened this issue Jun 8, 2017 · 1 comment
Closed

Incorrect N-API documentation for some functions accepting strings #13555

RReverser opened this issue Jun 8, 2017 · 1 comment
Assignees
@mhdawson
Labels
doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.

Comments

@RReverser
Copy link
Member

RReverser commented Jun 8, 2017 •
edited
Loading

Following functions accept const char* according to the docs, but in fact napi_value according to implementation:

  • napi_create_symbol
  • napi_create_error
  • napi_create_type_error
  • napi_create_range_error

/cc @nodejs/n-api
@RReverser RReverser added doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API. labels Jun 8, 2017
@RReverser RReverser mentioned this issue Jun 8, 2017
Closed
@RReverser RReverser changed the title Incorrect napi_create_symbol documentation Incorrect N-API documentation for some functions accepting strings Jun 9, 2017
RReverser added a commit to RReverser/emnapi that referenced this issue Jun 9, 2017
@RReverser
Fix napi_create*error to match headers not docs
dd14063 
nodejs/node#13555
@mhdawson
Copy link
Member

mhdawson commented Jun 9, 2017

thanks, will fix up in a doc PR next week.

@mhdawson mhdawson self-assigned this Jun 9, 2017
@mhdawson mhdawson mentioned this issue Jun 13, 2017
Closed
3 tasks
mhdawson added a commit to mhdawson/io.js that referenced this issue Jun 15, 2017
@mhdawson
doc: fix a few n-api doc issues
05bc598 
- Add doc for napi_create_string_latin1().
- Fix signatures where c string was specified instead of napi_value.
- Fix return type of napi_callback.
- Update to specify that napi_escape_handle() can only be called once
  for a given scope.

Fixes: nodejs#13555
Fixes: nodejs#13556
Fixes: nodejs#13562
addaleax pushed a commit that referenced this issue Jun 17, 2017
@mhdawson @addaleax
doc: fix a few n-api doc issues
e7b0ec3 
- Add doc for napi_create_string_latin1().
- Fix signatures where c string was specified instead of napi_value.
- Fix return type of napi_callback.
- Update to specify that napi_escape_handle() can only be called once
  for a given scope.

PR-URL: #13650
Fixes: #13555
Fixes: #13556
Fixes: #13562
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jason Ginchereau <jasongin@microsoft.com>
Reviewed-By: Ingvar Stepanyan <me@rreverser.com>
addaleax pushed a commit that referenced this issue Jun 21, 2017
@mhdawson @addaleax
doc: fix a few n-api doc issues
c27ffad 
- Add doc for napi_create_string_latin1().
- Fix signatures where c string was specified instead of napi_value.
- Fix return type of napi_callback.
- Update to specify that napi_escape_handle() can only be called once
  for a given scope.

PR-URL: #13650
Fixes: #13555
Fixes: #13556
Fixes: #13562
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jason Ginchereau <jasongin@microsoft.com>
Reviewed-By: Ingvar Stepanyan <me@rreverser.com>
gabrielschulhof pushed a commit to gabrielschulhof/node that referenced this issue Apr 10, 2018
@mhdawson
doc: fix a few n-api doc issues
00ee027 
- Add doc for napi_create_string_latin1().
- Fix signatures where c string was specified instead of napi_value.
- Fix return type of napi_callback.
- Update to specify that napi_escape_handle() can only be called once
  for a given scope.

PR-URL: nodejs#13650
Fixes: nodejs#13555
Fixes: nodejs#13556
Fixes: nodejs#13562
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jason Ginchereau <jasongin@microsoft.com>
Reviewed-By: Ingvar Stepanyan <me@rreverser.com>
MylesBorins pushed a commit that referenced this issue Apr 16, 2018
@mhdawson @MylesBorins
doc: fix a few n-api doc issues
cc3a4af 
- Add doc for napi_create_string_latin1().
- Fix signatures where c string was specified instead of napi_value.
- Fix return type of napi_callback.
- Update to specify that napi_escape_handle() can only be called once
  for a given scope.

Backport-PR-URL: #19447
PR-URL: #13650
Fixes: #13555
Fixes: #13556
Fixes: #13562
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jason Ginchereau <jasongin@microsoft.com>
Reviewed-By: Ingvar Stepanyan <me@rreverser.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mhdawson mhdawson

Labels
doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@RReverser @mhdawson