README
1cdoc
2====
3
4This is a simple Doxygen project for building NumPy C code documentation,
5with docstrings extracted from the C sources themselves.
6
7The understood syntax for documentation in the C source is
8
9 /*
10 * Some text in reStructuredText format
11 */
12 int function_to_which_the_text_applies()
13 {
14 ...
15 }
16
17 /*
18 * More text in reStructuredText format
19 */
20 struct
21 {
22 int variable_1; /* Documentation for variable_1 */
23
24 /*
25 * Documentation for variable_2
26 */
27 int variable_2;
28 } struct_name_t;
29
30Please do not use JavaDoc or Doxygen-specific formatting at the moment.
31
32