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