Repository navigation
Documentation mismatch for N-API structures #13469
Description
Documentation on the N-API page describes napi_property_attributes as following:
typedef enum {
napi_default = 0,
napi_read_only = 1 << 0,
napi_dont_enum = 1 << 1,
napi_dont_delete = 1 << 2,
napi_static_property = 1 << 10,
} napi_property_attributes;whereas src/node_api_types.h describes it as:
typedef enum {
napi_default = 0,
napi_writable = 1 << 0,
napi_enumerable = 1 << 1,
napi_configurable = 1 << 2,
// Used with napi_define_class to distinguish static properties
// from instance properties. Ignored by napi_define_properties.
napi_static = 1 << 10,
} napi_property_attributes;Basically, values of all bit flags were inverted.
Given the last commit, it seems it's the documentation that is outdated here but would be nice to confirm and sync two places to agree with each other.
Another one is napi_property_descriptor - website docs don't mention second name field of type napi_value.
Activity
mscdex commentedon Jun 5, 2017
/cc @nodejs/n-api
RReverser commentedon Jun 5, 2017
@mscdex Right, thanks, forgot I can add labels and mention corresponding group myself...
jasongin commentedon Jun 5, 2017
Yes, the documentation is out of date. These changes were made in the code after that part of the documentation was originally written, and we forgot to update the doc.
mhdawson commentedon Jun 5, 2017
Will take a look at updating this tomorrow.
doc: fix out of date sections in n-api doc
RReverser commentedon Jun 8, 2017
Another one:napi_create_symbolexpects achar *fordescriptionaccording to docs, butnapi_valuein actual header file. Not sure which one is intended here (I would expect thechar *)?Moved to a separate issue: #13555
Fix napi_create_symbol according to headers
doc: fix out of date sections in n-api doc
doc: fix out of date sections in n-api doc
doc: fix out of date sections in n-api doc