Introduction
DoxyS is a code documentation tool for C++/C. DoxyS strives to yield a very professional looking output, presenting the the code in a structured easy to navigate set of HTML pages. Easy to use: just navigate to the root of your code directory and type doxys.
Currently it runs on Windows and Linux, but should be quite portable.
Main features
- Generated output reflects the code directory structure.
- Layers of abstraction with heavy use of overview tables providing names and brief descriptions of classes, functions etc. Inspired by Microsoft documentation.
- Wiki like syntax for writing directory level documentation and related documentation pages or even design documents.
Other key features
- Generated output reflects the code directory structure.
- Layers of abstraction with heavy use of overview tables providing names and brief descriptions of classes, functions etc. Inspired by Microsoft documentation.
- Wiki like syntax for writing directory level documentation and related documentation pages or even design documents.
- Built in incremental search engine (JavaScript).
- Various diagrams with mouse over effects to provide additional information.
- Strong support for templates, enumerations and overloaded functions.
- Freedom to put documentation blocks anywhere.
- Professional output with consistent placement of special sections like: Note, See Also, Examples etc.
- Automatic linking to known entities.
- Can cope with very large projects.
Screenshots
