CINXE.COM
Doxygen homepage
<!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="description" content="Source code documentation and analysis tool"/> <meta name="keywords" content="documentation,tool,source code,open source,GPL,analysis,structure"/> <meta name="generator" content="Doxygen 1.12.0"/> <title>Doxygen homepage</title> <link rel="icon" href="doxygen.ico" type="image/x-icon" /> <link href="bootstrap.min.css" rel="stylesheet" type="text/css" /> <link href="tocbot.min.css" rel="stylesheet" type="text/css" /> <link href="doxygen_homepage.css" rel="stylesheet" type="text/css" /> <script async defer src="https://buttons.github.io/buttons.js"></script> <script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-1917318012276499" crossorigin="anonymous"></script> </head> <body> <div id="main"> <div class="container"> <nav class="navbar fixed-top navbar-expand-md navbar-dark bg-primary doxygen-navbar"> <div class="container-fluid"> <a class="navbar-brand ms-3" href="index.html"><img src="assets/doxygen.svg" width="120" height="35" alt="Doxygen" /></a> <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarText" aria-controls="navbarText" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <div class="collapse navbar-collapse" id="navbarText"> <ul class="navbar-nav me-auto mb-0 mt-0 px-2"> <li class="nav-item mx-1"> <a class="nav-link" href="manual/index.html">Docs</a> </li> <li class="nav-item mx-1"> <a class="nav-link" href="manual/changelog.html">Changelog</a> </li> <li class="nav-item mx-1"> <a class="nav-link" href="helpers.html">Extensions</a> </li> <li class="nav-item mx-1"> <a class="nav-link" href="examples.html">Examples</a> </li> </ul> <ul class="navbar-nav mr-auto d-inline-flex my-0 mx-1 download-button"> <li class="nav-item bg-success download"> <a class="nav-link" href="download.html"> <img class="download-icon" src="assets/download.svg" width="16" height="16" alt="Download doxygen" /> <span>Download</span> </a> </li> </ul> <form action="https://www.paypal.com/cgi-bin/webscr" method="post" class="nav-item d-inline-flex px-1 mx-1"> <input type="hidden" name="cmd" value="_donations" /> <input type="hidden" value="doxygen@gmail.com" name="business" /> <input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted" /> <input type="hidden" name="lc" value="US" /> <input type="hidden" name="tax" value="0" /> <input type="hidden" name="item_name" value="Doxygen donation" /> <input type="hidden" name="no_shipping" value="1" /> <table class="donate"> <tr> <td class="donate-button"><input type="image" width="74" height="21" src="https://www.paypal.com/en_GB/i/btn/btn_donate_SM.gif" name="submit" alt="Donate to Doxygen with PayPal!" /></td> </tr> <tr> <td class="currency"><select size="1" name="currency_code"> <option selected="selected" value="EUR">€ (EUR)</option> <option value="USD">$ (USD)</option> </select></td> </tr> </table> </form> </div> </div> </nav> </div> <div class="container-fluid"> <div class="row doxygen-updates"> <div class="d-flex justify-content-center"> <p class="message"><a id="banner-link-updates" href="download.html">Version 1.12.0</a> is now available!<span class="release-spacer"> </span>Release date: 7 August 2024</p> </div> </div> </div> <div class="container-fluid"> <div class="row jumbotron "> <div class="col-md-4 m-auto justify-content-center text-center"> <h1>Code Documentation.<br /><strong>Automated.</strong></h1> <div class="lead"> <p>Free, open source, cross-platform.</p> </div> </div> <div class="col-md-8"> <div class="screenshot"> <div class="screenshot"> <div class=images-container> <img id="darkimage" class="dark-image" src="assets/DoxygenExample_dark.png" alt="Dark" /> <img id="lightimage" class="light-image" src="assets/DoxygenExample_light.png" alt="Light" /> </div> <div class="form-check form-switch"> <input class="form-check-input" type="checkbox" role="switch" id="imageToggle" checked> <label class="form-check-label" for="imageToggle">Show dark mode output</label> </div> </div> </div> </div> </div> </div> <div class="container-fluid"> <div class="row description"> <div class="d-flex col-md-8 ms-auto me-auto justify-content-center my-3"> <div class="description-text"> <p>Doxygen is a widely-used documentation generator tool in software development. It automates the generation of documentation from source code comments, parsing information about classes, functions, and variables to produce output in formats like HTML and PDF. By simplifying and standardizing the documentation process, Doxygen enhances collaboration and maintenance across diverse programming languages and project scales. </p> </div> </div> </div> </div> <div class="container-fluid"> <div class="row value-props"> <div class="d-flex col-lg-2 col-md-4 col-sm-6 ms-auto me-auto justify-content-center text-center"> <a id="prop-format" class="value-prop" href="#multiformat"> <div class="value-prop-icon format"></div>Multiple formats </a> </div> <div class="d-flex col-lg-2 col-md-4 col-sm-6 ms-auto me-auto justify-content-center text-center"> <a id="prop-markdown" class="value-prop" href="#markdown"> <div class="value-prop-icon markdown"></div>Markdown </a> </div> <div class="d-flex col-lg-2 col-md-4 col-sm-6 ms-auto me-auto justify-content-center text-center"> <a id="prop-cplusplus" class="value-prop" href="#cplusplus"> <div class="value-prop-icon cplusplus"></div>C++ </a> </div> <div class="d-flex col-lg-2 col-md-4 col-sm-6 ms-auto me-auto justify-content-center text-center"> <a id="prop-cplusplus" class="value-prop" href="#crossreferencing"> <div class="value-prop-icon crossref"></div>Cross-referencing </a> </div> <div class="d-flex col-lg-2 col-md-4 col-sm-6 ms-auto me-auto justify-content-center text-center"> <a id="prop-diagrams" class="value-prop" href="#diagrams"> <div class="value-prop-icon diagrams"></div>Diagrams </a> </div> <div class="d-flex col-lg-2 col-md-4 col-sm-6 ms-auto me-auto justify-content-center text-center"> <a id="prop-config" class="value-prop" href="#config"> <div class="value-prop-icon config"></div>Configuration </a> </div> </div> </div> <div class="container-fluid swimlane" id="multiformat"> <div class="row py-5"> <div class="d-flex col-md-4 mx-3 my-3 order-md-2"> <img src="assets/multiple_formats.svg" width="240px" /> </div> <div class="col-md-6 mx-3 my-2 order-md-1"> <h2>Multiple output formats</h2> <p>Doxygen can generate documentation in various output formats, such as HTML, PDF (via LaTeX), Word (via RTF), and XML. </p> <p>This flexibility allows developers to choose the format that best suits their needs or integrate the documentation into different systems.</p> </div> </div> </div> <div class="container-fluid swimlane" id="markdown"> <div class="row py-5"> <div class="d-flex col-md-6 mx-3 my-3"> <img src="assets/markdown_demo.png" width="100%" /> </div> <div class="col-md-5 mx-3 my-2"> <h2>Markdown</h2> <p>Markdown support in Doxygen allows you to combine the simplicity of Markdown with the powerful features of Doxygen for documenting code. </p> <p>Next to Markdown, Doxygen supports many <a href="manual/commands.html">commands</a> like <code>\param</code>, <code>\return</code>, <code>\brief</code>, etc., to provide additional information about functions, parameters, and return values.</p> </div> </div> </div> <div class="container-fluid swimlane" id="cplusplus"> <div class="row py-5"> <div class="d-flex col-md-6 mx-3 my-3 order-md-2"> <img src="assets/cplusplus_image_perspective.png" width="100%" /> </div> <div class="col-md-5 mx-3 my-2 order-md-1"> <h2>C++</h2> <p>Doxygen provides robust support for documenting C++ code, recognizing the intricacies of the language and generating comprehensive documentation. </p> <p> Next to C++, Doxygen also supports C, Python, PHP, Java, C#, Objective-C, Fortran, VHDL, Splice, IDL, and Lex. </p> </div> </div> </div> <div class="container-fluid swimlane" id="crossreferencing"> <div class="row py-5"> <div class="d-flex col-md-6 mx-3 my-3"> <img src="assets/cross_referencing_demo.png" width="100%" /> </div> <div class="col-md-5 mx-3 my-2"> <h2>Cross-referencing</h2> <p>Doxygen provides cross-referencing capabilities, allowing users to navigate between different parts of the documentation. </p> <p>Doxygen generates hyperlinks to related elements, making it easy to explore the codebase and understand the relationships between different components.</p> </div> </div> </div> <div class="container-fluid swimlane" id="diagrams"> <div class="row py-5"> <div class="d-flex col-md-6 mx-3 my-3 order-md-2"> <img src="assets/diagrams_demo.svg" width="100%" /> </div> <div class="col-md-5 mx-3 my-2 order-md-1"> <h2>Diagrams</h2> <p>Doxygen can generate graphical representations of class hierarchies and collaboration diagrams, providing a visual overview of the relationships between classes and functions. </p> </div> </div> </div> <div class="container-fluid swimlane" id="config"> <div class="row py-5"> <div class="d-flex col-md-6 mx-3 my-3"> <img src="assets/config_demo.png" width="100%" /> </div> <div class="col-md-5 mx-3 my-2"> <h2>Configuration</h2> <p>Doxygen provides a configuration file (Doxyfile) that allows users to customize the documentation generation process. You can control various settings, such as the output format, file inclusion/exclusion, and more. </p> </div> </div> </div> <div class="container-fluid" id="sponsors"> <div class="row"> <div class="col-md-4 text-center"> <div class="carbonads"> <script async="" type="text/javascript" src="https://cdn.carbonads.com/carbon.js?serve=CK7DTK3M&placement=stacknl" id="_carbonads_js"></script> </div> </div> <div class="col-md-4 text-center"> <h3>Sponsored links<br /> <small>(not related to doxygen)</small> </h3> <ul class="list-unstyled"> <li><a href="https://www.maid2clean.co.uk/domestic-cleaning/">home cleaning</a></li> <li><a href="https://www.voetbalgokken.nl/bookmakers/">bookmakers</a></li> <li><a href="https://onelessthing.co.uk/">Domestic cleaning service</a></li> </ul> </div> <div class="col-md-4 text-center"> <div class="googleads"> <ins class="adsbygoogle" style="display:block" data-ad-client="ca-pub-1917318012276499" data-ad-slot="5320520181" data-ad-format="auto" data-full-width-responsive="true"></ins> <script> (adsbygoogle = window.adsbygoogle || []).push({}); </script> </div> </div> </div> </div> <div class="container-fluid doxygen-footer"> <footer class="d-flex flex-wrap justify-content-between align-items-center py-4 ms-4 mb-0"> <ul class="nav col-md-4 d-flex align-items-center list-unstyled"> <li class="ms-3"><a href="https://twitter.com/doxygen">Follow @doxygen</a></li> <li class="ms-3"> <div class="github-star-button"><a class="github-button" href="https://github.com/doxygen/doxygen" data-show-count="true" aria-label="Star on GitHub">Star</a></div> </li> <li class="ms-3"><a href="notify.html">Be notified</a> </li> </ul> <ul class="nav col-md-4 justify-content-end list-unstyled d-flex me-4 align-items-center flex-grow-1"> <li class="ms-3"><a href="support.html">Support</a></li> <li class="ms-3"><a href="privacy.html">Privacy</a></li> <li class="ms-3"><a href="license.html">License</a></li> </ul> </footer> </div> <script src="bootstrap.min.js"></script> <script src="tocbot.min.js"></script> <script src="doxygen_homepage.js"></script> </body> </html>