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
12
votes
2 answers

Doxygen C++ conventions

I'm at the beginning of a C++ project and I've been using Doxygen from the start. I'd like to know how you use Doxygen in your project, i.e. I have several questions: 1. Where do you put your Doxygen comments? Header or sources? I think that they…
halifar
  • 207
  • 3
  • 6
12
votes
1 answer

Insert link to function in another file with Doxygen?

I have two C source files. A comment to a function bar()in file A needs to refer to a function foo() in file B. How can I make this link? I tried: Writing something like: B.c::foo() hoping that doxygen would go to file B and find function foo…
user10607
  • 3,011
  • 4
  • 24
  • 31
12
votes
3 answers

error using doxygen and graphViz: problems opening map file

I'm using Doxygen-1.8.7, which i have downloaded from official website in dmg version. I'm using 10.9.3 MacOS. I have installed graphviz 2.38.0.0 via macports. I use Doxygen GUI to configure it and run. Everything works great, if i choose "use…
Amadey
  • 421
  • 1
  • 4
  • 9
12
votes
3 answers

Can I suppress vacuous 'More...' links on Doxygen class reference pages?

A Doxygen class reference page consists primarily of lists of class members, each followed by its brief description (if such exists). The member proper is a link to a details page for that member. Invariably the brief description is followed by a…
John Yates
  • 1,027
  • 1
  • 7
  • 18
12
votes
2 answers

how do i make doxygen ignore function-like macros when building the documentation?

I need to document a project with doxygen, but also need to ignore some macros, which I use for readability in small sections of my code, for which it makes no sense to appear in the documentation. here's a minimal example (I mainly use the macros…
Davide
  • 505
  • 1
  • 7
  • 16
12
votes
2 answers

Documenting variables with Doxygen in C

Code: #include /* * \var int iOne * \brief Integer 1 */ /* * \var int iTwo * \brief Integer 2 */ /* * \var int iThree * \brief Integer 3 */ /** * \brief Imitates a sheep. */ void sheep(); /** * \brief Main function for test…
Pieter
  • 31,619
  • 76
  • 167
  • 242
12
votes
2 answers

How do i remove the source path in doxygen

I am using doxygen to generate a chm document for my header files. I have a problem in removing the path of the source (i.e header files) in my chm. For example if the path of my header files is c:\users\dx\Desktop\myprogram, my path seems to appear…
Dan K
  • 218
  • 5
  • 12
12
votes
2 answers

Doxygen: How to include an element in multiple groups

The Doxygen documentation says that \ingroup can be used to add an entity to multiple groups: \ingroup ( [ ]) The problem is that I tried it and Doxygen adds the entitiy to just the last group in the group list.…
user2432986
  • 121
  • 1
  • 5
12
votes
1 answer

Delphi & Doxygen

I wanted to document my source using doxygen + pas2dox. When I set everything up, including the filter and the extraction options (extract everything), doxygen runs fine. But the generated documentation only includes the source-files as links and no…
Tobias Langner
  • 10,634
  • 6
  • 46
  • 76
12
votes
3 answers

Doxygen - declare parameter as optional

I am documenting a codebase using Doxygen and was wondering if there is a keyword for declaring an argument to a function to be optional. Something like: /*! \fn int add(int a, int b=0) \brief adds two values \param a the first operand \param…
ewok
  • 20,148
  • 51
  • 149
  • 254
12
votes
1 answer

How to disable latex in doxygen config

I want doxygen documentation generator not to generate any LaTeX files at all. HTML is enough for me. Is it possible to configure doxygen.ini to do so?
ducin
  • 25,621
  • 41
  • 157
  • 256
12
votes
3 answers

Doxygen private function

Is there a way to have doxygen show the documentation for individual private functions? I want doxygen to not show the documentation for the vast majority of private functions but show it for a select few private functions. My motivation is that…
duffsterlp
  • 347
  • 1
  • 5
  • 15
12
votes
1 answer

Is it possible to prevent Doxygen from outputting protected members?

As the title suggests, is it possible to automatically remove protected members from DOxygen output? I can see options to include private members but no mention of protected members?
Jon Cage
  • 36,366
  • 38
  • 137
  • 215
12
votes
5 answers

Doxygen: \code tag kills indentation

In doxygen I write: /*! Sample: \code{.cpp} void main(int argc, char** argv) { if (argc < 2) { cout << "no way!" << endl; } else { foobar(argv[1]); } } \endcode */ Now doxygen will generate a perfectly…
Alexander Tobias Bockstaller
  • 4,657
  • 4
  • 36
  • 58
11
votes
1 answer

Using doxygen to create documentation for existing C# code with XML comments

I've read everywhere that doxygen is the way to go for generating documentation for C# code. I've got a single interface that I want to document first (baby steps), and it already has the XML comments (///) present. Because of the vast number of…
Dave
  • 14,618
  • 13
  • 91
  • 145
1 2 3
…
99 100