doc: correct struct definition #969
Conversation
doc/version_management.md
Outdated
| @@ -25,13 +25,12 @@ information is stored in the `napi_node_version` structure that is defined as | |||
| shown below: | |||
|
|
|||
| ```cpp | |||
| using napi_node_version = | |||
| struct { | |||
| using napi_node_version = struct { | |||
There was a problem hiding this comment.
I believe the intention of this code block is just showing how struct napi_node_version is defined in node_api_types.h, but not how users should define the types. As the type struct napi_node_version is defined as followings:
typedef struct {
uint32_t major;
uint32_t minor;
uint32_t patch;
const char* release;
} napi_node_version;I believe the best way to do this here is to keep aligned with node_api_types.h or just remove the code block to prevent confusion.
There was a problem hiding this comment.
@legendecas I think it would be better to keep the code block. I have a PR open to replace the typedefs with usings in main repo that also changes this part in the file: https://github.com/nodejs/node/pull/38228/files#diff-9751c3fa7589557e1988160cbf907aa233c3cff86e1320fbc634d80394c918edR37-R42. Maybe we should wait for a confirmation on that PR before changing this?
There was a problem hiding this comment.
What I really mean is that header files like node_api.h, js_native_api.h, and so on are C headers but not C++ headers. We are not intended to use C++ features like using declarations in them. It's by design so that pure C programs can also using node-api too.
There was a problem hiding this comment.
@legendecas Thanks for letting me know that it's a C header. Updated the PR. PTAL.
RaisinTen
force-pushed
the
doc/remove-unnecessary-struct-name
branch
from
ad9cfb1 to
2c4418d
Compare
RaisinTen
changed the title
No description provided.