Stack Overflow
Stack Overflow

Questions tagged [doxygen]

Doxygen is a multilanguage documentation generation application for C++, C, Java, Objective-C, Python, IDL, Fortran, VHDL, PHP and C# that supports a wide variety of output formats including RTF, HTML, XML and PDF.

Doxygen is a documentation generation application written by Dimitri van Heesch that supports a wide variety of output formats including RTF, HTML, XML and PDF. It supports code in C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, and to some extent D. It is available for Linux, MacOS and Windows. The application is licenced under the GNU General Public License.

Features of Doxygen

  • Generate documentation in various formats including HTML, XML, LaTex, Man Pages, RTF and PDF.
  • Finegrained configuration possibilities to decide what parts of the code is included in the documentation.
  • Extract the code structure from documented or undocumented source files.
  • A number of different diagrams such as dependency graphs, inheritance diagrams and collaboration diagrams can be generated.
  • Additional documentation pages such as overview, howtos etc. can be included in the documentation structure.
  • Tight integration with the .dot graphic tool enables quick graphing utilities for state diagrams etc.

See Also

3108 questions
1
vote
0 answers

Doxygen - Latex enumerate list item doesn't show properly

I have generated latex using Doxygen, I want to edit some pages and add an enumerate list in there, when I edit it, it doesn't show properly, it's like being overwritten with text there. here is the code latex-code here is the…
Giga
  • 11
  • 1
1
vote
0 answers

Doxygen document preprocessor-generated code

I have some code that looks like this: enum ID { Opt_Invalid = 0, #define OPTION(id, ...) Opt_##id #include "path/to/Options.inc" Opt_None #undef OPTION } and in Options.inc : #ifdef OPTION OPTION(optionA, ...) OPTION(optionB, ...) #endif I…
gkrls
  • 2,618
  • 2
  • 15
  • 29
1
vote
0 answers

Sphinx show values next to define macros

I am generating documentation for a C++ project using Doxygen, doxyrest and Sphinx. For Sphinx, I'm using the Sphinx Book Theme. I wanted to know if there exists a possibility, when accessing a macro (#define MAXIMUMSIZE 20, for example) in the…
Mario Mateaș
  • 638
  • 7
  • 25
1
vote
1 answer

cross referencing to doxygenfunction from sphinx

I have a problem with C++ domain. In my index.rst I have :cpp:func:`Hello()` In hallo.rst I have the following lines: .. cpp:function:: Hello .. doxygenfunction:: Hello The line with doxygenfunction works and I get the documentation generated…
Tarek
  • 29
  • 2
1
vote
3 answers

Doxgen uses outdated version of bison OSX Big Sir

I am trying to use Doxygen to create documentation for my code. Following the Doxygen documentation, when I run cmake -G "Unix Makefiles" .. the compiler tells me CMake Error at CMakeLists.txt:112 (message): Doxygen requires at least bison version…
Enrique Avina
  • 973
  • 7
  • 20
1
vote
0 answers

How to copy folder with contents in Doxygen generated HTML

I have a folder with several SVG and xlsx files. I want Doxygen to copy this folder into the generated HTML folder. The HTML_EXTRA_FILES tag is set to the folder but does not copy the folder and contents. How do I properly configure the Doxyfile so…
Lrom
  • 13
  • 5
1
vote
0 answers

Remove methods from TOC

When generating documentation, the TOC (navigation) includes entries for classes, namespaces, and methods. I would like to remove the entries for methods; this just clutters up the TOC, since we have hundreds of methods. Is there an easy way to do…
JJT
  • 59
  • 3
1
vote
0 answers

Disable panel synchronization (remove button)

I'd like to remove the option to disable panel synchronization. Any chance there is a flag for this that I somehow overlooked? I am able to remove it if I update the navtreedata.js file, but then when I rebuild it comes back. I have added navtree.js…
JJT
  • 59
  • 3
1
vote
0 answers

Include C++ Example in a Sphinx/Breathe/Doxygen Documentation

I'm trying to include an example in my C ++ documentation through Sphinx, Breathe and Doxygen. It doesn't seem to be easy, because the @example statement doesn't work. And with the @include statement, the *.rst-file is output as simple text and not…
Tarek
  • 29
  • 2
1
vote
1 answer

Doxygen : link to a Related Page

Say I have a page, in the Related Pages section, named states.md. Now, in the doc of a specific method, I want to tell users to go see that file for more details, like "See states.md", with an hyperlink to the page. The problem is, I have no problem…
TwilCynder
  • 33
  • 6
1
vote
2 answers

Where can I host generated private documentation?

I'm using Doxygen to generate documentation on a C++ project. I want to share this documentation with various team members without them having to build the docs themselves. In an ideal world, there's a service to privately host the static HTML…
Graham Plank
  • 11
  • 1
1
vote
0 answers

How to link to a class in a different namespace with doxygen

I'm documenting a Python project with doxygen (1.8.17). I want to reference the documentation for a class from the main page. I define the latter in a comment block with @mainpage, that is in a separate file from the one that defines the class. When…
Pythonist
  • 1,937
  • 1
  • 14
  • 25
1
vote
0 answers

how to link enum class in @return? in Doxygen, VScode

I am trying to write a code in Doxygen style documentation. Problem I want to link enum class results. But link is not seen in VScode when mouse is on function name. Code I made small test example for question :) test.h /*! A global enum */ enum…
TyeolRik
  • 466
  • 2
  • 25
1
vote
1 answer

Doxygen: why is the first element of my enum class not properly copied with copydoc?

I have the following code: /** * @brief OpenGL renderer rescale types */ enum class RescaleType { None, //!< No rescale Horizontal, //!< Rescale horizontally Vertical, //!< Rescale vertically Both //!< Rescale both }; /** *…
jacky la mouette
  • 523
  • 4
  • 17
1
vote
0 answers

Doxygen only reading comments from begining of file in MATLAB

I am trying to document some MATLAB code using Doxygen, but it is only reading comments from the top of the file. I am using this github repo for converting the MATLAB to be readable by doxygen: https://github.com/simgunz/doxymatlab. I would like to…
cdreyfus
  • 11
  • 2
1 2 3
…
99 100