How do you document your C++ code?

This page summarizes the projects mentioned and recommended in the original post on /r/cpp

Our great sponsors
  • WorkOS - The modern identity platform for B2B SaaS
  • InfluxDB - Power Real-Time Data Analytics at Scale
  • SaaSHub - Software Alternatives and Reviews
  • Obidog

    Ă–bengine BInding and DOcumentation Generator

  • To export XML which I then parse with a custom Python tool (https://github.com/ObEngine/Obidog) which will then do two things :

  • hyde

    A front-end to Jekyll that parses C++ sources to produce and enforce out-of-line documentation (by adobe)

  • Adobe Hyde

  • WorkOS

    The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

    WorkOS logo
  • standardese

    A (work-in-progress) nextgen Doxygen for C++

  • standardese

  • breathe

    ReStructuredText and Sphinx bridge to Doxygen

  • I use Sphinx documentation system with Breathe plugin: https://github.com/michaeljones/breathe for {fmt} docs: https://fmt.dev/latest/index.html.

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts