Documentation generator for C/C++
A python script which can be used for generating a html documentation for the comments in your code.
Features
- Custom pointer, end of linked list notation,
- Static notation,
- Doxygen-like commenting,
- Comes with English and Hungarian example config.
Usage
The script only picks up these comments:
- //? Is defining what the file content is used for.
- //- Is struct documentation
- //! Is function/method documentation
Configurable values
def_value_label="(Default value)"def_ret_label="Returns:"def_linked_label="Next linked list element"def_param_label="Parameters:"def_no_ret_label="(Has no return value)"def_no_par_label="(Has no input parameters)"def_comment_label="Integer";pointer_label="(Pointer)";static_var_ids=[]static_comments=[]
First, you need to tune the script to fit your needs.
Then, run:
python doc_generator.py
After that, you need to specify:
- Documentation project name
- Create document from header files? (y/n)
- Create document from source .c files? (y/n)