Skip to content

docs: add missing stdint includes in examples in math/base/napi/binary #2728

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

Merged
merged 2 commits into from
Aug 1, 2024
Merged

docs: add missing stdint includes in examples in math/base/napi/binary #2728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e0b6ec
docs: add missing stdint includes in examples
gunjjoshi Aug 1, 2024
90612dc
docs: fix macro name
kgryte Aug 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion lib/node_modules/@stdlib/math/base/napi/binary/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -621,6 +621,8 @@ When used, this macro should be used **instead of** `NAPI_MODULE`. The macro inc
Macro for registering a Node-API module exporting an interface for invoking a binary function accepting and returning signed 32-bit integers.

```c
#include <stdint.h>

static int32_t add( const int32_t x, const int32_t y ) {
return x + y;
}
Expand All @@ -642,6 +644,8 @@ When used, this macro should be used **instead of** `NAPI_MODULE`. The macro inc
Macro for registering a Node-API module exporting an interface for invoking a binary function accepting signed 32-bit integers and returning a double-precision floating-point number.

```c
#include <stdint.h>

static double add( const int32_t x, const int32_t y ) {
return x + y;
}
Expand Down Expand Up @@ -951,7 +955,7 @@ static double fcn( const int64_t x, const int64_t y ) {
// ...

// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_II_D( fcn );
STDLIB_MATH_BASE_NAPI_MODULE_LL_D( fcn );
```

The macro expects the following arguments:
Expand Down
4 changes: 4 additions & 0 deletions lib/node_modules/@stdlib/math/base/napi/binary/include/stdlib/math/base/napi/binary.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@
* @param fcn binary function
*
* @example
* #include <stdint.h>
*
* static int_32 add( const int_32 x, const int_32 y ) {
* return x + y;
* }
Expand Down Expand Up @@ -110,6 +112,8 @@
* @param fcn binary function
*
* @example
* #include <stdint.h>
*
* static double add( const int_32 x, const int_32 y ) {
* return x + y;
* }
Expand Down