Skip to content

Commit ef84849

Browse files
committed
docs: add C API documentation for inv-two-pi constant
1 parent 943bf1f commit ef84849

1 file changed

Lines changed: 54 additions & 0 deletions

File tree

  • lib/node_modules/@stdlib/constants/float32/inv-two-pi

lib/node_modules/@stdlib/constants/float32/inv-two-pi/README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,60 @@ console.log( FLOAT32_INV_TWO_PI );
6060

6161
<!-- /.examples -->
6262

63+
<!-- C interface documentation. -->
64+
65+
* * *
66+
67+
<section class="c">
68+
69+
## C APIs
70+
71+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
72+
73+
<section class="intro">
74+
75+
</section>
76+
77+
<!-- /.intro -->
78+
79+
<!-- C usage documentation. -->
80+
81+
<section class="usage">
82+
83+
### Usage
84+
85+
```c
86+
#include "stdlib/constants/float32/inv_two_pi.h"
87+
```
88+
89+
#### STDLIB_CONSTANT_FLOAT32_INV_TWO_PI
90+
91+
Macro for the inverse of twice the mathematical constant [π][pi] (1/(2π)).
92+
93+
</section>
94+
95+
<!-- /.usage -->
96+
97+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
98+
99+
<section class="notes">
100+
101+
</section>
102+
103+
<!-- /.notes -->
104+
105+
<!-- C API usage examples. -->
106+
107+
<section class="examples">
108+
109+
</section>
110+
111+
<!-- /.examples -->
112+
113+
</section>
114+
115+
<!-- /.c -->
116+
63117
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
64118

65119
<section class="related">

0 commit comments

Comments
 (0)