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
1 answer

Doxygen for php doesn't handle default parameter array

I tried searching a solution for my problem, but I can't find anything. My problem is that doxygen for php doesn't handle default parameters if they are an array: Code: /** * @brief convert rgb values to hexa decimal, and return array. * @param …
Jens
  • 84
  • 1
  • 10
1
vote
1 answer

How to run the Doxygen binary installed by its Conan package inside a CMake script?

Currently, I programmatically generate a conanfile.txt using two functions I have written: message(STATUS "Fetching Doxygen from Conan.") add_project_dependencies(${PROJECT_NAME}_docs CONAN BUILD_DEPS REQUIRED…
Saeid Akbari
  • 115
  • 8
1
vote
2 answers

Why doesn't CLion highlight Doxygen comments differently?

In CLion (2021.1), it seems all comments are syntax-highlighted the same way, even if they're Doxygen documentation comments. I couldn't find a Doxygen plugin which might help with that. How can I make CLion highlight Doxygen differently?
einpoklum
  • 118,144
  • 57
  • 340
  • 684
1
vote
0 answers

How to properly document C array with static array indices specifier function parameters in doxygen?

I have the following C function and I would like to generate doxygen documentation for it //! Function description /*! \param paramA[][] description \param paramB[] description !*/ static void foo( int paramA[static const…
MarisaMargatroid
  • 11
  • 1
1
vote
1 answer

Doxygen crashes while trying to patch "patching output file" with "Error: Problem writing Fig 1 figure!"

So I have a really weird error. Whenever I include this part of my javadoc /** * Maps a get request that gets the SSE stream with the given UUID * * @param id UUID of SSE stream to get * @return SSE stream for the given UUID …
SirHawrk
  • 610
  • 1
  • 4
  • 17
1
vote
1 answer

Is there a way to refer to the class' @brief in the doxygen?

Let's say, we have the following doxygen comment: /** * @brief The cool class. * * More info... */ class A {}; I'd like that "The cool class." brief has been appeared on some arbitrary place. For example, I'd like to make a table with list of…
Serge Roussak
  • 1,731
  • 1
  • 14
  • 28
1
vote
1 answer

How can I configure doxygen module page's default detail level?

I'm using doxygen generating document html website. By using @defgroup command, I can generate module pages, they are just like manually made index. There are at least 2 detail levels for my "manually made index" (the module page). Once a man…
ChrisZZ
  • 1,521
  • 2
  • 17
  • 24
1
vote
0 answers

Doxygen: Refer to members in another group

I have a C++ project where we use Doxygen to document our code. The documentation for it is split in a main group and a subgroup. What I've noticed is that the automatic link generation does not look in other groups than the current one. Thus, my…
Smartskaft2
  • 468
  • 3
  • 16
1
vote
1 answer

What is the name for comments with '@' in them?

This is a case of not being able to look something up because I don't know the name for it. In many code editors you can include these in the preceding comment block of a definition and then get helpful mouse-over text elsewhere, or other programs…
Liam Gallagher
  • 170
  • 1
  • 9
1
vote
1 answer

How to get a different name for a doxygen man page for a utility program

I have a C program called ncdump.c, and I am documenting it with doxygen. When I generate the man page, I get one called ncdump.c.3. This is not helpful. I need ncdump.1. I know how to change the man page section in the Doxyfile, but how do I get…
Edward Hartnett
  • 882
  • 7
  • 16
1
vote
1 answer

how to get doxygen to have man pages in several different manual sections?

What do I do if I have man pages that should have different extensions within the same project? The Doxyfile contains the following: The MAN_EXTENSION tag determines the extension that is added to the generated man pages (default is the subroutine's…
Edward Hartnett
  • 882
  • 7
  • 16
1
vote
1 answer

Use "\return" as "\brief"

For very simple functions I would like to only have a \return section, but still show it as brief. (How) Can this be done? For example: /** \return The distance. */ template R distance(const pcg32 &other); this generates no…
Tom de Geus
  • 5,625
  • 2
  • 33
  • 77
1
vote
1 answer

How to use doxygen to produce a pdf with custom latex stylesheet and commands?

How to use doxygen to produce a pdf with custom latex stylesheet and commands ? I need to document this code : ~\doxygenLaTex> more main.cpp #include //! \page MainPage Main program //! This program is meant to say hello! int main()…
fghoussen
  • 393
  • 3
  • 16
1
vote
1 answer

Doxygen duplicates member group if in namespace

I just noticed a problem in my documentation. I have a file where I have a set of definitions that I am trying to document together, in this form: namespace ABC { /** * @name ABC * * Hello. * * @{ */ using…
Svalorzen
  • 5,353
  • 3
  • 30
  • 54
1
vote
1 answer

#defined enum on Doxygen

So I have a #define that creates a "MY_ENUM" (minimal version) #define MY_ENUM(ename, ...) \ namespace ename { \ enum ename { __VA_ARGS__, COUNT }; \ …
Ivan
  • 1,352
  • 2
  • 13
  • 31
1 2 3
…
99 100