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

How to specify image size in HTML Doxygen?

I am trying to manually specify the image size in the HTML generated by Doxygen. However, as I read in the documentation, this can only happen if using LaTeX output. Anybody here knows any workaround? As an example, I would like to do something like…
Oriol Nieto
  • 5,409
  • 6
  • 32
  • 38
21
votes
3 answers

Exclude some classes from doxygen documentation

I am building a Qt based project, and many Qt classes are found in the target documentation. How can I tell Doxygen to disable documentation generation for some classes? For Q.*?
elcuco
  • 8,948
  • 9
  • 47
  • 69
20
votes
4 answers

How can I hide a particular function (in c++) in doxygen?

I have a class which has may functions and i want to hide a particular function. For example class Test { /** * About Function1 * * @param[in] arg1 About arg1 * @param[in] arg2 About arg2 */ public void…
Rana
  • 457
  • 1
  • 3
  • 9
20
votes
3 answers

How to include Doxygen method description in Xcode's autocomplete popup?

Using Xcode , I want to have the Doxygen description of my method below the autocomplete option, like alloc: When writing, Xcode displays the autocomplete with the comments from the documentation. You can see in the image for example, when alloc is…
antonicelli
  • 333
  • 1
  • 4
  • 11
20
votes
4 answers

Doxygen not documenting main function in main.cpp

I have a main.cpp that contains a struct, some global constants and a main function. I ran doxygen and the only documentation I am getting in the output index.html is for my struct. I want doxygen to document into that index.html file my main() as…
user1496542
  • 539
  • 2
  • 6
  • 14
19
votes
2 answers

Making Doxygen read double-slash C++ comments as markup

I'm trying to set up automated Doxygen runs on our massive 78,000 file C++ codebase. It's doing okay with extracting basic type and hierarchy information, but I'd like to make it smarter about picking up the documentation comments that are already…
Crashworks
  • 40,496
  • 12
  • 101
  • 170
19
votes
3 answers

Doxygen -- Single Comment Block for Multiple Functions

Are you able to use a single commenting block to comment multiple functions in doxygen? Below is a simple example that does not work. Can I do something similar to get what I want? file.cpp #include file.h /// @name FunsGroupedInDoxygen ///@{ /** …
Napthali
  • 305
  • 1
  • 2
  • 7
19
votes
2 answers

How to use Doxygen plugin in Android Studio?

I need to create a document for my app in Android Studio. I have already created document using Doxygen in eclipse but I don't know how to use Doxygen in Android Studio to generate automatic documentation. I tried searching the web but all I could…
Vicky
  • 921
  • 1
  • 11
  • 33
19
votes
2 answers

Measuring Documentation Coverage with Doxygen

I wanted to ask if there are any features (or add-ons) for Doxygen to measure the documentation coverage via command line. I already know that I can set up Doxygen to write undocumented elements as warnings into a log file, but to fully evaluate the…
user2455387
  • 191
  • 1
  • 3
19
votes
4 answers

header label in doxygen markdown page makes header title disappear

I notice a strange problem with doxygen 1.8.2. Including a header label causes the header title to disappear from the output html. With the following markdown file: Title {#title} ===== Section 1 {#section1} --------- Text for…
Masked Man
  • 1
  • 7
  • 40
  • 80
18
votes
1 answer

Use doxygen to document members of a c structure outside of the structure definition

I am using doxygen to comment my C code. I am making use of a foreign API (i.e. not my own) for which documentation is scarce so I intend to document some of that API within my own source files. I do have the header file for the foreign API but it…
Ben
  • 1,339
  • 1
  • 11
  • 15
18
votes
1 answer

Doxygen won't find headers in subdir

I'm documenting a C++ library's header files with Doxygen. In the Doxyfile, I defined INPUT = include/ in the hopes that Doxygen would then generate documentation for all the header files in include/Foo, but it doesn't: only the index.html is…
Fred Foo
  • 355,277
  • 75
  • 744
  • 836
18
votes
1 answer

Build doxygen from CMake script

I found on the Web a sample cmake file and put it in the /doc subdirectory of my project, where the file myproject.doxgen is also located, containing Doxygen configuration. I've tested that running doxygen.exe myproject.doxygen produces valid…
amigo421
  • 2,429
  • 4
  • 26
  • 55
18
votes
2 answers

How do you create a line break in Doxygen markdown?

I'm having a hard time locating the documentation explaining how to add a line break in Doxygen markdown. I've tried using two spaces at the end of the line, and I've also tried a single or double newline, but none of these are working for me. I'm…
user2211907
18
votes
1 answer

Gitlab and HTML documentation

My development environment consists of Git repository, GitLab repository manager and Jenkins. During build process a documentation is generated with Doxygen in HTML format. Is it possible to store that documentation on GitLab project's wiki? I know…
Kajsa Gauza
  • 1,348
  • 1
  • 12
  • 22
1 2 3
…
99 100