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

How to use Doxygen tableofcontents command

I am trying to use tableofcontents command from Doxygen Doc. To me \tableofcontents['{'[option[:level]][,option[:level]]*'}'] seems very cryptic. Could you give an example of how to pass options and levels?
BakSa
  • 121
  • 3
1
vote
1 answer

I have mutiple folders I want to include in doxywizard

I have mutiple folders I want to include in doxywizard. Any Idea how can I do that? Currently If I select folder with multiple subfolder in it and when I run doxygen, It is not showing me any output.
Aarit Soni
  • 101
  • 1
  • 4
1
vote
1 answer

Building Doxygen from source now requires Git? Can this be skipped?

I'm upgrading from Doxygen 1.8.11 to 1.8.16, both built from source on Linux (Ubuntu 18.04 in this case, but expected across various distros and versions going back at least to 2014), and I'm getting this error: ... -- Performing Test…
codesniffer
  • 1,033
  • 9
  • 22
1
vote
0 answers

Doxygen How to document header files found with Preprocessor

This is a complicated scenario, but I thought I'd ask in case someone has done this or ran across this issue before. I have specified the input files specifically as shown here: INPUT = ../groupsrc/WebPage.cc However, inside WebPage.cc there is…
ls6777
  • 386
  • 1
  • 5
  • 14
1
vote
1 answer

Doxygen fails to recognize parameters with using namespace

I've the following header file: #ifndef DATA_EXCEPTION_HPP_ #define DATA_EXCEPTION_HPP_ #include "Data/Global.hpp" #include #include namespace Data { class DATA_LIB Exception : public std::exception { public: …
Jepessen
  • 11,744
  • 14
  • 82
  • 149
1
vote
0 answers

Doxygen misinterpretes instantiation as member

I'm working on a documentation of a source code using Doxygen. I found that Doxygen interpretes within the following code: #include namespace space { //! first common length const quint16 val1 = 10; //! second common length …
Alex44
  • 3,597
  • 7
  • 39
  • 56
1
vote
0 answers

doxygen doesn't document my variables in c++

First of all there is 2 other question like this in stackoverflow but none of them solved my problem. This is my source code: /** @file * \brief Brief description of this file. * * Detailed description here */ /** The main function. I will now…
SMMousaviSP
  • 624
  • 7
  • 23
1
vote
1 answer

some doubts about the style of C code comments

I have some doubts about the style of C code comments. like this: /* \brief Creates a new shm pcm */ sometimes it like this: /* \!brief Creates a new shm PCM */ What is the difference between the "\brief" and "\!brief"
375
  • 57
  • 6
1
vote
0 answers

Editing Code Template in Eclipse to enforce doxygen documentation

I try to enforce/motivate some fellows to comment their Code so that it becomes more understandable. Therefore, I wanted to use the Template functionality in Eclipse. For now I added the following Template (which is of course not working) using some…
user11344770
  • 23
  • 4
1
vote
1 answer

Doxygen are not collecting all \todo in global todo list

I have a problem with doxygen. Not all my \todo are collected in the global todo list, but most of them. I have made a simple C-example with a single source and header file, as well as a configuration file, where i have placed todos everywhere i…
Jesper J
  • 21
  • 4
1
vote
1 answer

doxygen create a top level project that indexes / links to sub projects

I have read this and this but I still can't figure out how to do this. So I have here is a fictional example (just to keep it small/simple): top_level/ | |--- proj1/ | |--- html/ | |--- proj2/ | |--- html/ So here…
code_fodder
  • 15,263
  • 17
  • 90
  • 167
1
vote
0 answers

How do I use a more intuitive code block in doxygen?

I am trying to use code blocks with Doxygen; however, this method I've used does not seem intuitive and I am wondering if there's a better method, that will include inline code. public class DropZone : MonoBehaviour { private void…
Sebastian Djurovic
  • 11
  • 3
1
vote
1 answer

Documentation comments for function groups

I want to generate an API documentation with Doxygen. As it's a C API, I can have neither default arguments nor templates, so the straightforward /** @brief foo * Do the foo * @param typed A typed parameter * @param bar Optional parameter 1 *…
tstenner
  • 10,080
  • 10
  • 57
  • 92
1
vote
0 answers

How to run doxygen documentation generation from cmake

I'm trying to simply run a doxygen dox_er_ros command from cmakeLists.txt file to generate documentation for the project. The dox_er_ros file path is /src/er_ros/ and the cmake file exists in /src/ directory I've tried using execute_process() and…
gabrielQ
  • 11
  • 2
1
vote
1 answer

Trying to change the header and/or footer in Doxygen

I'm new to Doxygen and not an expert with HTML and I am trying to change the header and/or footer on my Doxygen outputted page. I tried editing the main.html and tree.html, but whenever I run Doxygen (command line - doxygen Doxyfile) it refreshes…
Miyah Boyd
  • 11
  • 3
1 2 3
…
99
100