https://github.com/wenzel/doxify
Quick C++ source code documentation generator based on doxygen.
https://github.com/wenzel/doxify
Last synced: 10 months ago
JSON representation
Quick C++ source code documentation generator based on doxygen.
- Host: GitHub
- URL: https://github.com/wenzel/doxify
- Owner: Wenzel
- License: gpl-2.0
- Created: 2014-12-07T23:44:22.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2014-12-25T10:48:55.000Z (over 11 years ago)
- Last Synced: 2025-01-02T05:13:14.125Z (over 1 year ago)
- Language: Shell
- Size: 148 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
doxify
======
Quick C++ source code documentation generator based on doxygen
to facilitate understanding of unknown project code structure
and navigate easily into it, thanks to call graphs generation.
Usage
------
./doxify my_project/src
With `my_project/src` being the root directory of your source code tree.
By default, doxify will generate the documentation in the current directory.
Alternatively, you can specify an output dir :
./doxify my_project/src my_project/doc
Dependencies
-------------
This script obviously depends on `doxygen`, so please install it before.
Otherwise, `doxygen` can make use of `dot` to generate advanced and nicer call graphs.
If the `dot` executable cannot be found on your system, you will get a
warning from `doxify`.