Skip to content

Commit 97eb9c7

Browse files
kgrytekgryte
committed
Add snippet for documenting C APIs
1 parent 17f1cd2 commit 97eb9c7

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

‎tools/snippets/c.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
<!--lint disable first-heading-level-->
2+
3+
<!-- Copy everything below -->
4+
5+
<!-- C interface documentation. -->
6+
7+
* * *
8+
9+
<section class="c">
10+
11+
## C APIs
12+
13+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
14+
15+
<section class="intro">
16+
17+
</section>
18+
19+
<!-- /.intro -->
20+
21+
<!-- C usage documentation. -->
22+
23+
<section class="usage">
24+
25+
### Usage
26+
27+
```c
28+
#include "stdlib/TODO.h"
29+
```
30+
31+
#### todo( TODO )
32+
33+
TODO
34+
35+
```c
36+
TODO
37+
```
38+
39+
</section>
40+
41+
<!-- /.usage -->
42+
43+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
44+
45+
<section class="notes">
46+
47+
</section>
48+
49+
<!-- /.notes -->
50+
51+
<!-- C API usage examples. -->
52+
53+
<section class="examples">
54+
55+
### Examples
56+
57+
```c
58+
TODO
59+
```
60+
61+
</section>
62+
63+
<!-- /.examples -->
64+
65+
</section>
66+
67+
<!-- /.c -->

0 commit comments

Comments
 (0)