CofeehousePy/deps/numpy/doc/cdoc
Netkas 3294bc4ea6 Added NSFW classification 2021-01-14 02:07:24 -05:00
..
Doxyfile Added NSFW classification 2021-01-14 02:07:24 -05:00
Makefile Added NSFW classification 2021-01-14 02:07:24 -05:00
README Added NSFW classification 2021-01-14 02:07:24 -05:00
__init__.py Added numpy 2021-01-12 22:41:40 -05:00
numpyfilter.py Added NSFW classification 2021-01-14 02:07:24 -05:00

README

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.