#Doxygen multiple source directories series#
This post is the first in a series based on best C++ documentation practices for Sphinx+Doxygen workflows. Doxygen also support multiple source directories (in an other meaning). Though this is still a feasible method, a monolithic multi-project setup might benefit from Sphinx, which is what will be covered. regarding the Doxygen variable STRIPFROMPATH when built remotely. The Doxygen documentation lists different commenting styles. But there are multiple ways of using special commenting styles to extend the information created.
#Doxygen multiple source directories code#
In the past I have been more than happy to document C++ code using only Doxygen (with pretty fantastic results), while keeping example usage separate ( d-SEAMS wiki). source/api if you have separate source and build directories with Sphinx. Doxygen is able to generate documentation from standard sources. INPUT 'src' INPUT + 'spaced folder/test/src' Reference: the + operator can be used instead of to append new values to the list. Organize the directory a bit, such that the structure looks like this: include/cppdoxygensphinx.hpp src/cppdoxygensphinx.cpp And edit the files such that they read: for cppdoxygensphinx. It is strongly recommended to build the code in a separate directory from the source (the semi-automatic installer enforces this). My project proposal for documenting Symengine was recently accepted for the Google Summer of Docs initiative. Here is my proposed solution, where you quote each folder, and use the multiline syntax. This post outlines a basic workflow for C++ projects using Doxygen, Sphinx, and Exhale.
0 kommentar(er)
