Search code examples
pythonc++doxygendocumentation-generation

How to use doxygen in a project containing both C++ and Python (multi-programming language project)


I am creating documentation for my project which has codes written in both C++ and Python. I can generate documentation with doxygen on my C++ codes, but find no way to do the same with my Python codes after I have the former files. And if I need both doxygen documents to appear under the same index.html, i.e. to merge them into one uniform doxygen file, how can I do this? What is the convention that everyone uses?


Solution

  • First off, thank you albert and shawnhcorey for your quick responses. I tried what you suggested, and made the following modifications to parse documentation comments from files written in both languages:

    In Doxyfile

    INPUT = include/my_package/ scripts/my_package/

    Both directories are separated by space.

    Then,

    FILE_PATTERNS = *.h *.py

    The two wildcards patterns are also separated by a space.

    Back to where you placed your doxyfile, then run

    doxygen
    

    And off you go!