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

Choosing between attention, note, remark, todo and warning in Doxygen

The documentation generator Doxygen allows to mark a piece of comment as attention, note, remark, todo or warning. What guidelines should I follow to properly classify a comment as one of them?
toliveira
  • 1,533
  • 16
  • 27
24
votes
8 answers

How to use eclox, the doxygen plugin for Eclipse

How do I get eclox working in Eclipse 3.5? I'm using Ubuntu 9.04. I installed Doxygen from ubuntu repositories(version 1.5.8). Then I installed eclox on eclipse through the update site. Despite this, I don't get any option to in any menu to initiate…
ruwan.jayaweera
  • 1,196
  • 3
  • 11
  • 25
24
votes
2 answers

Doxygen: Show numerical Enum values without changing CSS?

I need a way to get doxygen to show the real value of the enum member in the doxygen output. For instance I have: ///MyEnum typedef enum My_Enum { MY_ENUM_0,///
noti
  • 887
  • 7
  • 25
24
votes
3 answers

Generate documentation as markdown files using doxygen

I know that it is possible to use markdown inside comments and doxygen can understand it. But I need to know if it is possible to generate the documentation in markdown format? I need these documentation to be generated from C++ files.
Sudar
  • 18,954
  • 30
  • 85
  • 131
23
votes
6 answers

How to document python function parameter types?

I know that the parameters can be any object but for the documentation it is quite important to specify what you would expect. First is how to specify a parameter types like these below? str (or use String or…
sorin
  • 161,544
  • 178
  • 535
  • 806
23
votes
1 answer

C++ private class member variables don't appear in the documentation

Class is documented as follows: /** * @brief Number representation */ class CNumber : public CElem { /** @brief Holds true for negative values */ bool neg; ... However, the variable documented in the code doesn't appear in the…
notnull
  • 1,908
  • 3
  • 19
  • 25
23
votes
3 answers

Issue getting Doxygen to document an enum in C

I have a rather odd problem with Doxygen (1.6.1 on Mac OS X Snow Leopard) in that it does not seem to document my enums no matter what I do. I am programming in C and have followed the instructions in the manual. Here is my code: /** * \enum…
Cromulent
  • 3,788
  • 4
  • 31
  • 41
22
votes
1 answer

Run Doxygen only on select files / modules?

Recently I started writing some doxygen docs in an existing project which already has quite a lot of doxygen comments. Since I'm learning a bit - I like to iterate with making edits and generating docs, since doc generation is quite slow - 3-5min.…
ideasman42
  • 42,413
  • 44
  • 197
  • 320
22
votes
5 answers

How to get doxygen to run faster?

Doxygen is a bit slow - it takes about a couple of minutes to process my whole project, so for small incremental changes this is longer than actually building the rest of my code. There are thousands of files without any documentation so I guess it…
1800 INFORMATION
  • 131,367
  • 29
  • 160
  • 239
22
votes
3 answers

how do I run doxywizard?

I have successfully downloaded and installed doxygen. I am trying to run doxygen but am a little overwhelmed by the configuration file. I see that there is a utility called doxywizard that guides you through the creation of a configuration file. How…
bernie2436
  • 22,841
  • 49
  • 151
  • 244
21
votes
2 answers

using Doxygen in read-the-docs

I have written the documentation for a medium sized C++ piece of software using Doxygen together with Markdown. I am quite happy with it, as after changing the xml layer I ended up with something like that: …
solernou
  • 235
  • 1
  • 2
  • 9
21
votes
4 answers

Suppressing Doxygen warnings

Is there a way to suppress Doxygen from giving "not documented" warnings on particular files? My project has several automatically generated code headers that cause it to throw hundreds or thousands of errors that make it difficult to sift through.
Nick T
  • 25,754
  • 12
  • 83
  • 121
21
votes
4 answers

C++ meta-programming doxygen documentation

I am documenting some code which uses meta-programming heavily, for example: template struct Kernel, Transform, typename…
Anycorn
  • 50,217
  • 42
  • 167
  • 261
21
votes
3 answers

Function list on main page with doxygen

I'm sure this has already been asked somewhere but I can't seem to find it, so here it goes. I am creating a program in C and using Doxygen to generate documentation. I am quite satisfied with the results, however the main page has no content. I…
ZeroKelvinKeyboard
  • 408
  • 3
  • 8
21
votes
5 answers

How to install Doxygen GUI on Ubuntu?

I can't figure out how to install the Doxygen GUI (doxywizard) on Ubuntu. Where can I get it?
Pieter
  • 31,619
  • 76
  • 167
  • 242
1 2 3
…
99 100