diff options
Diffstat (limited to 'doc/cdoc/README')
| -rw-r--r-- | doc/cdoc/README | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/cdoc/README b/doc/cdoc/README new file mode 100644 index 000000000..98be85484 --- /dev/null +++ b/doc/cdoc/README @@ -0,0 +1,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. + |