logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

breathe-apidoc - extract API documentation from Doxygen

Description

breathe-apidoc  parses  the XML output generated by doxygen(1) and extracts the API documentation for use
       with Sphinx.

       The following command line arguments are recognized:

       PATH   the location of the index.xml file generated by Doxygen

       -oDESTDIR, --outputDESTDIR
              directory to place all output

       -f, --force
              overwrite existing files

       -m, --members
              include information about members of class, group, interface, namespace, and struct types

       -n, --dry-run
              run the script without actually creating output files

       -T, --no--toc
              do not create a table of contents files

       -sSUFFIX, --suffixSUFFIX
              file extension for the created Sphinx input files (defaults to .rst).

       -pPROJECT, --projectPROJECT
              add project PROJECT to generated directives

       -q, --quiet
              suppress informational messages

Name

       breathe-apidoc - extract API documentation from Doxygen

Note

       This manual page was written for the Debian project by Timo Röhling, and may be used without restriction.

breathe-apidoc 4.31.0                             October 2021                                 BREATHE-APIDOC(1)

See Also

doxygen(1)

Synopsis

breathe-apidoc-oDESTDIR [-f] [-m] [-n] [-T] [-sSUFFIX] [-pPROJECT] [-gTYPE] [-q] PATH

See Also