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
18
votes
3 answers

Is there a standard for documenting GET/POST parameters?

In a PHP project, even when front controller logic is used for the main application, there can be many stand-alone scripts, ajax snippets and so on. Is there a standardized way - either PHPDoc or something else - to define in the first comment block…
Pekka
  • 442,112
  • 142
  • 972
  • 1,088
18
votes
2 answers

Documenting with doxygen: put details on top

I'm using doxygen for a documentation of an Android project. I know doxygen since years. But now I have the problem that I want the details of my class like in javadoc at the top and not at the bottom. After a short Google search I found the option…
rekire
  • 47,260
  • 30
  • 167
  • 264
18
votes
1 answer

Including doxygen's LaTeX output as an appendix to a larger document

I have a "project book" which uses LaTeX's \documentclass{report} ("report" is like a more compact version of \documentclass{book}). I would like to include into this book an appendix with the Doxygen-generated API documentation for the software in…
markgalassi
  • 390
  • 6
  • 11
17
votes
4 answers

sh: dot: command not found + doxygen + Lion

MacOS version: 10.7.2 (Lion) Doxygen version: 1.7.5.1 Graphviz version: 2.29 Doxygen configuration: DOT_PATH = ../../../../Applications/Contents/MacOS/Graphviz HAVE_DOT = YES SHORT_NAMES = YES From the log console, first line it gives a…
Salil
  • 496
  • 1
  • 5
  • 15
17
votes
1 answer

How to add an external resource (pdf file) in my doxygen documentation

I generate a doxygen documentation. In one of my "page" I have a link to a pdf file: Overview This file is in my project in another directory. The documentation ends up in folder called…
Barth
  • 15,135
  • 20
  • 70
  • 105
17
votes
4 answers

doxygen comment multiple variables at once

If I have the following: /** * @brief (x,y,z) points for block */ int x, y, z; It will only generate that documentation for x, is it possible in doxygen to get it to comment all x, y and z with one comment? EDIT Following the suggestions of envu…
cjh
  • 1,113
  • 1
  • 9
  • 21
17
votes
1 answer

Doxygen warning: no uniquely matching class member found for

I'm using Doxygen for a C++ project. When I'm building the html doc, I get the following error: C:/Amir/Programming/Eclipse C++/CacheOptimization/src/CacheLruNaiveAlgorithm.cpp:19: warning: no uniquely matching class member found for void…
Amir Rachum
  • 76,817
  • 74
  • 166
  • 248
17
votes
7 answers

Any software to auto generate doxygen comment blocks?

I'm developing a large C++ program and I've now decided to document it with Doxygen. There are plenty of classes, methods, functions, macros and so on. Therefore I'm searching for software that would scan my source tree and insert Doxygen comment…
Simone Margaritelli
  • 4,584
  • 10
  • 45
  • 70
17
votes
2 answers

Doxygen does not find files when specifying Source directory

Hello, I try to use doxygen to generate code documentation from a set of folders. My folder structure is like this: +root +-include/ +-include/subdir/file.h +-src +-src/subdir/file.cpp +-Documentation/doxygen.config Then in the configuration file…
Jan Jaap
  • 437
  • 1
  • 4
  • 13
17
votes
1 answer

How to set a favicon for Doxygen output

I am automating documentation generation using Doxygen. How can I specify a favicon (URL icon) for the output?
Andrew Ring
  • 3,185
  • 1
  • 23
  • 28
17
votes
5 answers

Hiding template implementation details from Doxygen

One of the (so very many) unfortunate design flaws of C++ is that it is basically impossible to separate implementation from interface when using template metaprogramming. All over my library I have things like: template
trbabb
  • 1,894
  • 18
  • 35
17
votes
2 answers

How to generate inline code section with Doxygen?

My narration has code snippets, e.g., ::SomePlatformAPI() that are not part of my code base and Doxygen warns that warning: explicit link request to 'SomePlatformAPI()' could not be resolved I tried to add \code and \endcode around it but then the…
kakyo
  • 10,460
  • 14
  • 76
  • 140
17
votes
1 answer

Doxygen: Group modules and pages?

I have a question about pages and groups in doxygen. I have a project, where I grouped classes etc. with the @defgroup and @ingroup cmds. So far this works fine. Now I'd like to add special documentation to the project with markdown pages. These…
schieska
  • 253
  • 1
  • 3
  • 8
17
votes
2 answers

Emacs + C/C++ + Doxygen: Alternative to doxymacs? With yasnippet?

I would like to use doxygen to generate code documentation (of functions) in .c or .cc files with Emacs. I found doxymacs, but it seems not to be maintained anymore (latest version 2007) and I also did not find a way to update the documentation of a…
Marius Hofert
  • 6,546
  • 10
  • 48
  • 102
16
votes
2 answers

Is there an @inheritDoc equivalent in Doxygen?

I know Javadoc will compile {@inheritDoc}, but what's the Doxygen way to do this?
Roberto
  • 11,557
  • 16
  • 54
  • 68
1 2 3
…
99 100