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

Visual studio auto complete Doxygen tags for C++

Is there a way to make visual studio automatically place the doxygen tags in a C++ source file ? What I mean is for example this piece of code: int foo(bool p); If I type /// on top of it, Visual Studio automatically generates the following…
Pierre Baret
  • 1,773
  • 2
  • 17
  • 35
13
votes
2 answers

doxygen syntax in python

Can somebody please help me to figure out how to comment python code correctly to get parsed by doxygen? Somehow it ignores the tags. The output (HTML) shows the tags: @brief Creates a new Hello object. This Hello Object is beeing used to…
Mark
  • 7,507
  • 12
  • 52
  • 88
13
votes
3 answers

Incorrect image paths for doxygen

tl;dr question: What is the actual algorithm doxygen uses to find images referenced to in doxygen comments? And the corollary, what's considered best practice which won't break in future doxygen versions? Details: We're trying to institute a policy…
Sean Curtis
  • 1,425
  • 7
  • 8
13
votes
1 answer

Is there a negative effect if using @ instead of \

I've been using doxygen for a little while now. The editor(N++) I use creates doxygen comments with backslashes for the special commands. The doxygen manual says: All commands in the documentation start with a backslash ( \ ) or an at-sign ( @ ).…
Cyren Cooper
  • 143
  • 1
  • 7
13
votes
2 answers

Generate single-file HTML code documentation

How can I use Doxygen to create the HTML documentation as a single, very long file? I want something like the RTF output, but as HTML. The reason: I need my API published as a single, printable, document. Something that can be loaded into Word,…
noamtm
  • 12,435
  • 15
  • 71
  • 107
13
votes
2 answers

How to escape special commands in Doxygen inline code

I want to use inline code in a Doxygen comment: Use `#define` for something.. Which produces the following warning: warning: explicit link request to 'define' could not be resolved How can I escape the # sign in order to omit this warning? If I…
riot_starter
  • 1,218
  • 15
  • 28
13
votes
6 answers

Doxygen with C# internal access modifier

I am using Doxygen to generate some API docs for a C# project I am working on. I have quite a bit of "internal" functionality in this project and don't want Doxygen producing these signatures in the generated html it produces. I have tried enabling…
Mike Gates
  • 1,874
  • 3
  • 21
  • 40
13
votes
4 answers

How can I include '<' in Doxygen comments?

Say I'm documenting a member function using DOxygen/Visual studio compatible comments, how can I use the less than '<' symbol without creating a compiler warning but still maintaining readability in the codebase? For example, if I did this: ///…
Jon Cage
  • 36,366
  • 38
  • 137
  • 215
13
votes
1 answer

Documenting Get/Post Parameters with Doxygen or PHPDoc

I was looking through the documentation for PHPDoc and could not find a good way to document the Post variables I was sending to various methods. So, I started to look into Doxygen with the hopes that it would provide me with a better way to…
user1464055
  • 603
  • 2
  • 9
  • 19
13
votes
2 answers

How to document Ruby code using Doxygen?

Question: How can I document Ruby code using Doxygen? Disclaimer: I know ruby already has a system for documentation built in and there are probably other ways to do it as well, but the specific constraint I am operating under is how to get Doxygen…
dreftymac
  • 31,404
  • 26
  • 119
  • 182
12
votes
2 answers

Change the Theme of Doxygen?

I don't really think the Doxygen HTML theme for documenting C code is good for documenting functions and procedures (though it is awesome for documenting OOP if using C++). So what I'm asking is can the output be changed to resemble the SDL…
ApprenticeHacker
  • 21,351
  • 27
  • 103
  • 153
12
votes
1 answer

Relative files paths in doxygen-generated documentation

I am using Doxygen 1.7.4 for Windows. In the File List page of generated documentation I'd like to see relative paths. I have set FULL_PATH_NAMES = YES, to have something more, than just filename without path, but this gives full, absolute…
Soul Reaver
  • 2,012
  • 3
  • 37
  • 52
12
votes
2 answers

How to write a Doxygen comment for variadic function, i.e., a function with undefined number of arguments?

I am trying to write a doxygen block comment for a function with unlimited number of parameters, then I couldn't find a right tag for it. Supplied parameters should all be strings, and they will be concatenated in the function to form a new…
Joon
  • 9,346
  • 8
  • 48
  • 75
12
votes
1 answer

What is the correct way put multiple lines in a param tag for a Javadoc?

I can't find any information on whether or not it is ok to have multiple lines of info in a javadoc param. I'm making a chess engine and I want to be able to parse a string to generate a board. Is it ok to do it as I've done below? /** * Creates a…
Tejas Sharma
  • 462
  • 1
  • 4
  • 17
12
votes
2 answers

Using Doxygen with Visual Studio 2010

I have difficulties efficiently using Doxygen with Visual Studio 2010 and C++. Is there no other function for commenting than "un/comment lines"? For example generating comment stubs, and adding /// after a new line. Also, I wonder what is needed to…
Sven
  • 2,839
  • 7
  • 33
  • 53
1 2 3
…
99 100