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

Avoid line breaks in last column of table if comments are splitted in pieces

I am documenting my C/C++ code with doxygen. I want to collect the documentation for a (long) list of parameters in one single table: Each row of the table should have a short piece of code such that each parameter is documented where it is handled…
user3230853
1
vote
0 answers

Class diagram representation for C library with Doxygen

I am trying to generate a UML class diagram representation of my C libraries (library.c, library.h). I would like to get a representation containing public (extern) and private (static) functions / variables with the usual '+' and '-' signs, but all…
godo
  • 195
  • 1
  • 11
1
vote
1 answer

Document enum class values using Doxygen without enabling EXTRACT_ALL

I wasn't able to show documentation for values of enum classes without setting EXTRACT_ALL. The comments for preserve, truncate and append aren't there. The enum itself is documented. If I enable EXTRACT_ALL I get a list. My code is: namespace…
Martin Fehrs
  • 792
  • 4
  • 13
1
vote
2 answers

Building Doxygen on MSYS2

Currently I'm facing a problem, compiling Doxygen on MSYS2 using either MinGW32 or Mingw-w64 on Windows 10. I did: git clone https://github.com/doxygen/doxygen.git cd doxygen && mkdir build && cd build cmake -G "Unix Makefiles" .. make When using…
themole
  • 363
  • 3
  • 12
1
vote
0 answers

How to inlude multiple doxyfiles in a master doxyfile?

I am working on a project which has multiple modules with their own doxyfiles. My idea is to have a single master doxyfile which can include other private doxyfiles to create a one big documentation of the project. The directory structure looks like…
ata-ul- Manan
  • 11
  • 1
1
vote
1 answer

Doxygen comment inside a macro

My problem is the following : I have a set of files with the same parameters for constructors. I defined the parameters of a constructor inside a macro which is used in each file. For example, the following constructor…
benlaug
  • 2,691
  • 2
  • 17
  • 15
1
vote
1 answer

doxygen to document function declarations within C header files

Doxygen is able to document structs but it's not exporting any function declarations or macro definitions. For instance these defined in headers are not exported. /** Total instances */ #define TOTAL 10 /** Initializer */ void InitProduct(Product…
AppDeveloper
  • 1,816
  • 7
  • 24
  • 49
1
vote
1 answer

When doxygen-commenting a GPU kernel, how do I document information about the grid?

When writing the doxygen comment for a function, I use @param for its parameters, and I can also use @tparam for its template parameters. However, when writing a GPU kernel (OpenCL or CUDA), I can't quite find a way to document the choices w.r.t.…
einpoklum
  • 118,144
  • 57
  • 340
  • 684
1
vote
0 answers

Missing generated file in doxygen docs

In my C++ development, I am making the documentation with Doxygen 1.8.13. Basically it works fine, but in some cases (sorry, I could not figure out why) a warning message The file /Myhome/build/doc/inline_mscgraph_1.eps does not exist! Skipping…
katang
  • 2,474
  • 5
  • 24
  • 48
1
vote
0 answers

Doxygen - hide detailed description

Is there any way to hide detailed description in doxygen's v1.8.17 generated html files if it's empty? Currently I am creating a C project documentation using doxygen's grouping mechanisms. Generated by doxygen html pages contain empty detailed…
MLapaj
  • 371
  • 3
  • 11
1
vote
1 answer

Doxygen project brief not including spaces

I am developing a project and using Doxygen for the documentation. In the config file, I have put PROJECT_BRIEF = dynamic and effective, but for some weird reason on the HTML, it is appearing as dynamicandeffictive without spaces in between. Is…
MaximV
  • 155
  • 11
1
vote
1 answer

Markdown - Embedding images with a relative path

I searched quiet a lot, but could not find a solution that works. It seems it is not possible to link local images with a relativ path in markdown. I am building a documentation with doxygen, using markdown. I am working with…
himbeerHummus
  • 45
  • 5
1
vote
0 answers

How can I configure doxygen to generate html with plain list of files?

I have a project with tree like structure written in C#. I need to list all *.cs files in plain list with comments. For…
Nick
  • 49
  • 6
1
vote
1 answer

Doxygen: Having "Modules" twice in the Table of Content with Fortran Code

I am currently documenting a F95/2003 software project with the help of doxygen. On the one hand I grouped corresponding pages with the help of @defgroup, @addtogroup, @ingroup.... which end up under the point Modules in the table of contents and…
M.K. aka Grisu
  • 2,338
  • 5
  • 17
  • 32
1
vote
0 answers

Doxygen document structure with python superclass

This is my first question in stack overflow: This is my Python project structure: superclass1: module class1 and it's modules class2 and it's modules superclass2: module class2-1 and it's modules class2-2 and it's modules How can I replace…
Emanuele Pallotta
  • 11
  • 1
1 2 3
…
99 100