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
2 answers

Doxygen MACRO_EXPANSION not working at all

I am using doxygen 1.8.20 relevant config: INPUT = @CMAKE_CURRENT_SOURCE_DIR@ ENABLE_PREPROCESSING = YES MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = NO SEARCH_INCLUDES = YES INCLUDE_PATH =…
mnesarco
  • 2,619
  • 23
  • 31
1
vote
0 answers

Revised: Can premade Doxygen documentation be added into a SharePoint Communication Site so that SP pages can link to relevant parts?

Revised: The original request specified adding Doxygen generated html pages to a SharePoint Communication site. However, Doxygen can generate documentation in other formats besides html. Although I am not as acquainted with using Doxygen…
Eric
  • 481
  • 2
  • 10
1
vote
0 answers

Map URLs not working for images. Looks like a subtle typo bug in the html output (Doxygen v1.8.20)

I did some troubleshooting of the map URLs not being clickable in my html output. I tracked it down to an extra 'a' prefixed to the value for the 'usemap' attribute. (or a missing 'a' on the map name attribute; note how the 'a' is in the id…
Michael
  • 2,118
  • 1
  • 19
  • 25
1
vote
0 answers

Can anyone tell me something about the doxygen.sty?

I'm using Doxygen to generate PDF document. So I need also make use of LaTeX. I generated the default LaTeX style file, i.e. the doxygen.sty. I want to use the latex package listings to make the code block (wrapped by Doxygen commands @code and…
Xiangting
  • 11
  • 2
1
vote
0 answers

Doxygen:Is there an option to checking spellings (spell check) in doxygen special comments

I am using Doxygen to generate PDF files Writing special doxygen comments inside .c and .h files I can able to run Doxygen on .c and .h files and parsing the special comments inside them and prepare .pdf file reports. Most of the times I found many…
Krishna Matsa
  • 23
  • 1
  • 6
1
vote
1 answer

Include both #ifdef and #else code in doxygen output

If have code in the following format: #ifdef MY_DEFINE ///some doxy comment #else ///other doxy comment #endif MY_DEFINE is defined at compile time. My issue is that when doxy processes the code above, only "other doxy comment" is handled.…
Chris Griffiths
  • 11
  • 1
1
vote
1 answer

Doxygen UML not showing type of attributes, methods and their arguments and returns

I'm trying to add to my UML diagram information about type of attributes, methods and their arguments and returns, but I can't find appropriate flag to set. What should I set to achieve this? I have: I want to achieve: My Doxyfile: #…
IzZy
  • 364
  • 3
  • 16
1
vote
2 answers

Doxygen manner of presentation member variables

How to change in doxygen on graphs this: to include member variables in second empty field? Edit: Inheritance graph is ok, only colaboration is problem Doxygen version : 1.8.17 Doxyfile: # Difference with default Doxyfile 1.8.17 PROJECT_NUMBER …
IzZy
  • 364
  • 3
  • 16
1
vote
0 answers

Setting Recursive tag ON does not searching sub folders for .NET projects

I am a newbie to doxygen tool. I've followed the doxygen configuration guide for generating a HTML document out of my C# source files. I am able to generate the HTML output, but I identified that it is generating output of the files that exists in…
Badri Prasad
  • 11
  • 1
1
vote
2 answers

Function overloads, documentation almost identical

I have two acquire functions and, besides their arguments, the documentation is identical. How should I handle this? Should I add something like "The same general notes found in function X's documentation also apply here"? If not, does Doxygen offer…
Paul Manta
  • 30,618
  • 31
  • 128
  • 208
1
vote
1 answer

Does anyone know how to use the Doxygen Tool in Azure DevOps?

Specifically I need the yaml for the build definition. I already have Doxygen and Latex installed on the agent machine. Also, I can create Doxygen documentation for the C# Restful API manually using the tool.
Bill Blair
  • 61
  • 1
  • 2
  • 10
1
vote
2 answers

Doxygen fails to process header files in Fortran code

I have a mature Fortran code which I would like to modernise and as part of this process incorporate doxygen comments throughout. The code contains header files which contain lists of variables (and previously common blocks) that could then be…
r.g.
  • 26
  • 4
1
vote
3 answers

How to tell doxygen to use /** as class doc instead /*! \class

I'm trying to switch from phpDocumentor to doxygen, but all my classes are documented in the following style: /** * DESCRIPTION * * @category PHP * @package UserManagement.Class * @author Name * @copyright 2011…
Christoph Fink
  • 22,727
  • 9
  • 68
  • 113
1
vote
1 answer

Alternative to \f in Doxygen for Latex formulas

In doxygen if you want your formulas to be formatted correctly you must do: \f$ x=2 \f$ I have lots of md files with math formulas. These files are part of an internal wiki and must abide by the algorithmic rules of that wiki. Which means latex is…
Makogan
  • 8,208
  • 7
  • 44
  • 112
1
vote
0 answers

Custom Doxygen Parameter

I want to do "global" variables in Doxygen. For example we have @param commands to specify parameter. I want to add new one as a "@param_global" I want to specify the global variables. How can I do that ?
mathco
  • 107
  • 11
1 2 3
…
99 100