doxygen/doxygen
Doxygen
Doxygen is a source code documentation generator and multi-language API reference tool. It extracts annotated comments from source code to create structured technical manuals and searchable software libraries in formats including HTML, LaTeX, and PDF.
The project functions as a static code analysis visualizer, generating call graphs, class diagrams, and inheritance hierarchies to illustrate codebase structure. It also serves as an XML documentation export engine, producing structured metadata that can be transformed via XSLT or third-party tools.
Beyond API extraction, the tool provides a Markdown technical documentation system for authoring prose guides and custom pages. It includes capabilities for requirement traceability management, source code visualization, and the generation of tracking lists for bugs and deprecated items.
The generation process is managed through centralized configuration settings and can be integrated into standard build systems to automate the documentation workflow.
Features
- API Metadata Extraction - Extracts annotated source code and structural information to create comprehensive API manuals.
- API Documentation Generators - Extracts annotated source code to automatically generate comprehensive API reference manuals in HTML, LaTeX, and PDF.
- Source Code Documentation Tools - Extracts annotated comments from source code to automate the creation of structured API references in multiple formats.
- Documentation Automation - Integrates documentation generation into build systems to synchronize manuals with the latest source code.
- Markdown Documentation - Uses a specialized combination of Markdown syntax and custom commands to author rich technical documentation.
- Multi-Format Document Exports - Produces documentation in multiple formats including HTML, PDF, Word, and XML.
- Multi-Format Document Rendering - Transforms internal documentation models into multiple targets including HTML, LaTeX, and PDF.
- Class Diagrams - Produces class inheritance and collaboration diagrams to visualize structural relationships between classes.
- Symbol Reference Mapping - Builds a global index of named entities to create hyperlinks between related functions, classes, and files.
- Technical Prose Generation - Enables the creation of comprehensive technical manuals and prose documentation alongside extracted API references.
- Code Structure Visualizations - Generates visual representations of code structure, including call graphs, class diagrams, and inheritance hierarchies.
- Multi-Language API Documentation - Generates unified technical API references from source code written in multiple different programming languages.
- Code Documentation Standards - Provides standardized paragraphs for documenting parameters, return values, and exceptions for code members.
- Code Relationship Visualization - Generates call graphs and inheritance diagrams to visualize the architecture and relationships of a codebase.
- Technical Reference Manuals - Creates comprehensive software guides by combining Markdown prose and extracted API references into a single publication.
- Function Call Mapping - Generates visual call graphs showing the invocation relationships between methods and functions.
- Structural Static Analysis - Extracts structured data from source code by scanning for specific comment patterns and syntax without execution.
- API Entity Grouping - Categorizes classes, modules, and namespaces into named groups to organize the API reference.
- Document Cross-Referencing - Provides a system for linking between symbols, files, and sections across technical documentation.
- Standalone Documentation Pages - Supports the definition of standalone pages and hierarchical sections independent of specific code entities.
- Technical Media Integration - Supports embedding images with captions and rendering mathematical formulas within the final output.
- Source Code Snippet Integration - Allows including external source code files as snippets with customizable line numbers.
- Documentation Metadata Exporters - Produces structured XML output of source code metadata to enable custom documentation generation via XSLT.
- XML Serialization Formats - Serializes parsed code structure into XML files to allow for external XSLT-based custom documentation generation.
- Documentation Tracking Lists - Automatically collects all occurrences of bugs, todos, and deprecated items into dedicated summary lists.
- Generation Configuration Systems - Provides a centralized settings file to control source file inclusion and output format options.
- Graphviz DOT Emitters - Generates dependency and inheritance diagrams by exporting structural data into Graphviz DOT files.
- Diagram Integrations - Integrates visual charts using inline definitions or external files into documentation pages.
- Markdown Documentation Tools - Provides a system for authoring and rendering technical manuals and prose guides using Markdown syntax.
- Dependency Visualization - Visualizes dependencies between different groups of documented entities through graphs and trees.
- Tool Configuration Management - Uses a central configuration file to manage file inclusion and output behavior.
- Documentation Comment Generators - Provides a utility to insert skeleton comment blocks into source code to standardize technical documentation.
- Dependency Graph Visualizations - Generates visual diagrams representing the header file include dependencies for source files.
- Requirement Traceability Frameworks - Implements a system for linking project requirements directly to the code entities that implement them.
- XSLT Transformations - Processes generated XML data using XSLT or third-party wrappers to create custom output formats.
- Outils de développement - Documentation generator for C++ and other languages.
- Documentation Tools - Standard tool for generating source code documentation.
- Documentation et connaissances - Standard tool for generating documentation from C++ source code.
