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

how to change default font size for graphviz?

I use doxygen + graphviz for documenting my code. graphviz does a nice job of generating images. Is there any way to change the default fontsize for graphviz? The default is 14, but I want to use 12 instead. Its a real pain to change the fontsize…
chronodekar
  • 2,616
  • 6
  • 31
  • 36
36
votes
4 answers

How do I link between markdown documents in doxygen?

I have a project with a set of markdown pages that are interlinked with links such as [Go to this page](subdir/MyOtherPage.md) The pages all get picked up by doxygen and appear in the output, but the links are not altered to point to their new html…
izb
  • 50,101
  • 39
  • 117
  • 168
35
votes
7 answers

Create "Quick Help" Entry in Xcode

How do I create quick help entries in Xcode for my own code? I just want it as a coding support, meaning like the Eclipse functionality when coding Java. In eclipse you get a comment you entered above a method when hovering a method somewhere…
m Jae
  • 725
  • 2
  • 8
  • 20
34
votes
2 answers

Difference between param[out] and return in doxygen?

What is the difference between \param[out] and \return in Doxygen? They both seem to document the output / return of a function. Is the difference due to void functions which don't have a return value and only param[out] would be valid?
Elpezmuerto
  • 5,391
  • 20
  • 65
  • 79
34
votes
4 answers

Documenting preprocessor defines in Doxygen

Is it possible to document preprocessor defines in Doxygen? I expected to be able to do it just like a variable or function, however the Doxygen output appears to have "lost" the documentation for the define, and does not contain the define itself…
Fire Lancer
  • 29,364
  • 31
  • 116
  • 182
33
votes
3 answers

A doxygen eclipse plugIn automatically generating stub documentation?

I'am looking for an eclipse-plugin for doxygen code documentation. I have found the eclox-plugIn ( http://home.gna.org/eclox/ ). I would like find out, how can it automatically generate a "empty" doxygen comment, which could be filled out later or…
LonliLokli
  • 1,295
  • 4
  • 15
  • 24
33
votes
5 answers

How to publish to Github Pages from Travis CI?

We are compiling Doxygen docs on the travis-ci server and want to push them onto our gh-pages branch. How do I handle the authorization for git push? Does someone have an example for using encrypted variables in travis-ci? Should I go for https…
Stasik
  • 2,568
  • 1
  • 25
  • 44
33
votes
2 answers

How to set an input directory for Doxygen?

I have a directory in which all source and header files are saved. I would like to run Doxygen to generate documentation for these source code. However, I do not want to change anything in this directory (in particular I cannot add sub directories…
Roman
  • 124,451
  • 167
  • 349
  • 456
32
votes
1 answer

Doxygen - Could NOT find FLEX (missing: FLEX_EXECUTABLE)

I know there are very similar worded questions on here, but I could not find an answer to my question there, so here we go: I'm trying to see which of my C++ methods are called by others so I found Doxygen after googling. On their page the…
Cold_Class
  • 3,214
  • 4
  • 39
  • 82
32
votes
2 answers

Doxygen not documenting static classes?

I've been recently using Doxygen for a project of mine. I'm having a problem though that it won't generate the proper documentation for a C# static class. Is there some option I have to enable? My complete source code for the relevant class is…
Earlz
  • 62,085
  • 98
  • 303
  • 499
32
votes
1 answer

What are the main differences of Sphinx and Doxygen?

I want to prepare a documentation for a collection of projects, modules and libraries in the field of computer vision (mostly written in c++). To this end I had a look on OpenCV documentation and as you may know OpenCV 2.4.x documentation is based…
Ali Mirzaei
  • 1,496
  • 2
  • 16
  • 27
32
votes
4 answers

Documenting functions in C++ with Doxygen

I've got a project that I'm using Doxygen to generate documentation for. The documentation of the classes is fine, but I've also got some non-member functions that I use to create objects etc. I'd also like to have these documented, but no matter…
Paul
  • 4,239
  • 6
  • 28
  • 29
32
votes
1 answer

Ignoring files in project folder for Doxygen

How can you ignore files by Doxygen similarly as by Git's .git/info/exclude? Doxygen generates docs for me based on 3rd party codes such Email -component and of my Git -repo, which I do not want. I need to keep the files where they are.
Léo Léopold Hertz 준영
  • 134,464
  • 179
  • 445
  • 697
31
votes
5 answers

Change doxygen comment style in Eclipse

Does anyone know how to edit the style used for Doxygen comments in Eclipse CDT? In other words type /** and pressing enter on a line before a function currently gives me something like: /** * * @param one * @param two * @return */ Foo(int…
deuberger
  • 3,578
  • 6
  • 31
  • 33
30
votes
2 answers

Can Eclipse hover tips display Doxygen comments from header file?

I'm using Eclipse CDT to write C++ code. Having read several discussions here on StackOverflow about whether to place doxygen documentation in the header file or the implementation file, it seems the majority of developers favour putting doxygen…
Jack Kelly
  • 2,214
  • 2
  • 22
  • 32
1 2
3
…
99 100