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
1
vote
1 answer

Doxygen doesn't generate any documentation

No documentation is generated for any of the functions for my C repo My configuration: # Difference with default Doxyfile 1.9.1 PROJECT_NAME = WLib OUTPUT_DIRECTORY = doxy OPTIMIZE_OUTPUT_FOR_C = YES EXTRACT_ALL =…
Wispy
  • 141
  • 1
  • 7
1
vote
0 answers

Doxygen not extracting all files

I am using doxygen to doxygenate a project that I am currently working on. My problem is that Doxygen is not extracting any documentation for my .hh files and the classes in them, only for main.cc. All my .hh files and my main.cc are in the same…
Ferran Hermida Rivera
  • 11
  • 3
1
vote
0 answers

Documenting Fortran/C mixed code with Doxygen

I have a mixed C++/Fortran codebase that I'm documenting with doxygen (1.8.8). The C++ functions that are exposed to Fortran have a trailing underscore notation. FORTRAN C++ CALL SUBRA( ... ) subra_( ... ) Is there a way to get doxygen…
nick
  • 11
  • 1
1
vote
0 answers

Getting 'Permission Denied' error trying to generate Doxygen documentation

I am trying to run the doxygen command (I'm using Windows 10 with Cygwin and the packages Doxygen, Graphviz and the g++ compiler installed with it) and, at the end of the execution, I get the following error: Error: Could not open…
alexland7219
  • 11
  • 1
1
vote
1 answer

Does Eclipse CDT support backslash as tag for Doxygen?

I was wondering whether or not Eclipse CDT supports the inclusion of Doxygen tag in the old fashion C style. And , if so, how to modify it. I mean instead of having JavaDoc tagging /** * @brief * * @param * @param * @param * @return …
ndarkness
  • 1,011
  • 2
  • 16
  • 36
1
vote
1 answer

Sphinx is not formatting overloaded Python function parameters correctly

I am using doxygen + Sphinx to generate documentation for some Python bindings I have written. The Python bindings are written using pybind11. When I write my documentation string for a non overloaded function, it formats properly. Here is an…
cyrusbehr
  • 1,100
  • 1
  • 12
  • 32
1
vote
0 answers

Doxygen struct documentation

/** * \brief my foo struct. * * Blah blah... */ typedef struct{ uint8 a;/**< A uint8 val */ union{ uint32 Data;/**< A uint32 val */ uint8 ba[4];/**< A uint8 array */ }union1;/**< my union 1…
Enes ÖZER
  • 11
  • 2
1
vote
1 answer

Include documentation of another project

I have a library (e.g. 'mylib') that derives from another library (e.g. 'GMatTensor'), e.g. by deriving from a class. Now I would like to include 'GMatTensor' in the documentation of 'mylib' e.g. to show derived methods. What works For my library of…
Tom de Geus
  • 5,625
  • 2
  • 33
  • 77
1
vote
0 answers

How to generate description and keywords metatags in Doxygen HTML output?

For better SEO, I'd like to generate the "description" and "keywords" metatags in the HTML output produced by Doxygen. I've noticed that these metatags are present in the original Doxygen HTML documentation. But I cannot figure out how to supply…
Miro Samek
  • 1,909
  • 14
  • 19
1
vote
0 answers

Doxygen callgraph with macro to the function

I am trying to generate the callgraph for the main function in the following code, where I pass the MODE_A as predefine. void FOO(int a); void ZOO(int a); #ifdef MODE_A #define function FOO #else #define function ZOO #endif /** *…
Yogesh
  • 33
  • 5
1
vote
0 answers

Hexadecimal value of c++ enum in doxygen documentation

i have some problem with doxygen documentation. I want to have something like E_SOME_ERROR | 0x000001 Detailed info about this error Important think is that I need values generated by doxygen but I can't find any solution. Do you guys know if this…
Mateusz
  • 21
  • 5
1
vote
0 answers

Alternative to doxygenfile for rendering file description with breathe

I have a project setup with doxygen + breathe for generating docs. I'm using the doxygenfile directive to display only the brief and detailed file description, like this: .. doxygenfile:: DynamicArray.h :sections: briefdescription…
inconstxpr
  • 23
  • 5
1
vote
0 answers

How to take the comments which are not related to the functioning and variables with Doxygen?

My Doxygen version : Doxyfile 1.8.20 Doxygen takes the comments of functions, variables... But if for example I want to comment on an if, it is not taken into account in the doc. I would like to have a comment section per piece of code that I…
JF-PS
  • 11
  • 3
1
vote
2 answers

How to set INPUT relative to Doxyfile?

I have a git repository for my project, and I'd like to add a Doxyfile in the repo so that anyone working on the project can create a directory on their computer and simply run doxygen /path/to/the/repo/Doxyfile from there to fill it with the…
Eternal
  • 2,648
  • 2
  • 15
  • 21
1
vote
2 answers

Mark doxygen comments and put them in a separate file / build documentation from source/comment blocks

My question is not easy to describe in a short caption, so i try to explain it more detailed: I want to generate documentation from comments in the source code. My favorite way would be a separately generated markdown file which contains the…
Stephan
  • 41
  • 3
1 2 3
…
99 100