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

2807 questions
1
vote
0 answers

Doxygen looking for third party headers referenced in namespace

Doxygen is generating errors because it can't find a header in a third party library. If I include the path to the header in the doxyfile, it then complains it can't find windows.h and other such headers. I don't want doxygen to reference those…
tdemay
  • 579
  • 6
  • 20
1
vote
0 answers

Doxygen breaks my code inside pre-tag

If I have a part of comment code in 
 block, Doxygen will broke it.
For example:
/*
 * Find biggest letter one can send by some amount of money
 * @param money how much money on has
 * @return weight of biggest letter on can send by that amount…
vesal
  • 29
  • 2
1
vote
1 answer

doxygen XML output: meaning of "@nn" in tag text?

I need to understand an aspect of the XML files generated by doxygen from C headers: the use of '@' followed by a number ("@nn") in the text of some tags. I've seen this notation used in two cases (but there may be more). In one case @nn seems to be…
Jonathan Sachs
  • 21
  • 1
1
vote
1 answer

How to insert the project name in a comment in doxygen?

I often use the project name in comments I write. However, up until now I hardcoded it. Now I realized that if the project name were to change, I would have to go through all the documentation parts and change it. Therefore, I wanted to ask if it is…
NOhs
  • 2,642
  • 3
  • 20
  • 51
1
vote
1 answer

Create doxygen link from text

I use doxygen to track features and user stories in my project. To do that, I would like to create links by the following way: There are enumerated paragraphs, which are the featerues: -# FT001: I, as -# FT002: I, as and so on... You…
user5528116
1
vote
2 answers

Document multiple enumeration/variables with the same description in doxygen

Is it possible to document multiple enumeration/variables with the same documentation? For example: enum { /// Description of Values VALUE_1 = 0, VALUE_2 = 1, VALUE_3 = 2 }; This results only VALUE_1 getting described by the doxygen…
Dennis Miller
  • 914
  • 9
  • 20
1
vote
1 answer

Hide Template Specialization Parameters in Doxygen Output

I'm writing a library which makes extensive use of meta-programing, and has traits classes such as /// Doxygen comments... template struct unit_traits
Nicolas Holthaus
  • 6,800
  • 3
  • 39
  • 79
1
vote
1 answer

How to avoid Python script name being regarded as namespace with Doxygen

I am now making documentations with Doxygen for Python scrips. Suppose the name of the script is all_the_best.py, and at the beginning of the scripts, I document it as follows: ## # @namespace scripts.python # This is a python script import…
feelfree
  • 9,501
  • 18
  • 76
  • 143
1
vote
1 answer

Comment inheritance in Doxygen fortran documentation

I am trying to write documentation for a fortran model using Doxygen. Some variables are defined in a specific module and then used in many other different modules using the use statement. That is I may have a f90 with the first module module…
Manfredo
  • 1,330
  • 2
  • 17
  • 46
1
vote
0 answers

Doxygen anchor inside function

I have a filter which converts actual code into @code/@endcode blocks but I can't figure out a way to create a @ref link to these sections. Here's a snippet of what I mean: /** * Refer to this example: @ref example1 * @param $arg1 * @param $arg2 …
pfa
  • 105
  • 15
1
vote
1 answer

Adding a function to multiple groups in doxygen

I am trying to add a function to multiple groups but it does not seems to be working. I followed the instructions from here Here are the comments I added: /** * \defgroup version1 version 1 */ /** * \defgroup version2 version 2 */ /** *…
Rana
  • 1,375
  • 1
  • 17
  • 47
1
vote
1 answer

Doxygen: Customizing the Examples Page

While documenting a project with Doxygen, I encountered the following problem. I have a set of example programs (demo_1.c, demo_2.c,...) which reside inside the EXAMPLE_PATH set in the Doxyfile. I created a file examples.c with the following content…
M.K. aka Grisu
  • 1,887
  • 2
  • 15
  • 28
1
vote
1 answer

Documenting C++ aliases in Doxygen

With the appropriate comment in front of it, Doxygen generates entries for class, struct and namespace declarations but not occurrences of typedef or using. In this example /// here is my typedef typedef int MyTypedef; /// here is my…
John McFarlane
  • 4,081
  • 2
  • 28
  • 33
1
vote
1 answer

Doxygen: \static command ignored for C member functions

I have C interface structs that look like this (non-relevant comment elements removed for brevity): struct ArrayInterface { /** * @static * @fn Array *Array::arrayWithArray(const Array *array) * @memberof Array */ Array…
jdolan
  • 561
  • 5
  • 13
1
vote
1 answer

Syntactical sugar for Doxygen to link a MonoBehaviour with Unity3D

We've just added the wonderful Doxygen to our project, and thus far we love it, specifically with the Dot visual graphs turned up to the max. One of the particular areas we like is when you're properly able to track where some services are created,…
seaders
  • 3,365
  • 3
  • 33
  • 59
1 2 3
…
99
100