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

How to get referrable URLs when generating docs with doxygen

We are using doxygen for our C project. Now we want to link to the generated docs from other web documents. But unfortunately the doxygen generated URLs are horrible and probably not static (i.e.…
mrh1997
  • 922
  • 7
  • 18
1
vote
0 answers

doxygen 1.8.17 clang crashing

Doxygen is failing with the below output on version 1.8.17 on Ubuntu 18.04. However, Doxygen 1.8.13 passes with NO issues. Searching for files in directory /home/rgleim/Git/RMS/pb980_dox/BD_GUI_Swarning: source media is not a readable file or…
ls6777
  • 386
  • 1
  • 5
  • 14
1
vote
0 answers

Graphviz dot and Doxygen does not generate UML diagrams

I have Graphviz dot set up correctly with dot.exe configured correctly in Doxygen. However, the html output does not contain any UML diagrams. There were no errors during Run too. Below are my settings, did I miss anything out? Thank…
gymcode
  • 4,431
  • 15
  • 72
  • 128
1
vote
0 answers

Doxygen complains that vector<>.resize is not documented

I'm trying to learn Doxygen. I almost have all warnings and errors found. However there are two that I cannot figure out. My code is something like namespace SE{ //! Description etc template class MyClass{ public: MyClass(int,…
TCD
  • 151
  • 1
  • 7
1
vote
0 answers

Have Doxygen source code browsing work in same-named workspace

I have a (large, old) fortran project for fluid simulations. It can create two executables, for compressible and incompressible flow respectively. Consequently, there are many routines that are named exactly the same between the two. When Doxygen…
James Wright
  • 1,293
  • 2
  • 16
  • 32
1
vote
0 answers

Doxygen: How to reference a SUBROUTINE inside a Fortran module?

I consider a Fortran API to a C code. Therefore, I have a proper documented C function execute_lua. For this function (and more functions) I have a Fortran module MODULE CINTERFACE ! Some definitions CONTAINS !> @brief Wrap the C function…
M.K. aka Grisu
  • 2,338
  • 5
  • 17
  • 32
1
vote
1 answer

Doxygen: ObjectiveC protocols of a class does not appear in HTML

I have an ObjectiveC class using some protocols. I use Doxygen to create documentation. @interface MyView : UIView < MyInterface1 , MyInterface2 > ... But generated HMTL is Inherits UIView. How can I get the protocols used in this class and…
SuperCed
  • 53
  • 5
1
vote
1 answer

doxygen: vertical alignment of parameter / template parameters' names

I'm documenting some C++ code using doxygen (version 1.8.13). When I am documenting function's parameters / template parameters, the result I get is the following one: /*! * ... * @tparam Field The field to be decoded. * @tparam Container The…
Davide
  • 387
  • 2
  • 11
1
vote
1 answer

Doxygen Markdown Links to main page do not work

I am creating a documentation using Doxygen 1.8.17 which has several overview pages written in Markdown. For this I am creating a main page and a few other pages, which will contain links between each other like shown in this post and in the doxygen…
Elbrecht85
  • 85
  • 7
1
vote
1 answer

Doxygen indentation in markdown files

I'm using doxygen to consume markdown files. However, I'm running into an issue related to indentation. Doxygen doesn't seem to recognize '>' for indentation. I also don't want 4 spaces because I don't want code blocks. I want subsections under…
ls6777
  • 386
  • 1
  • 5
  • 14
1
vote
0 answers

Can Doxygen document a block of methods with common parameters?

I have a situation in C++ where there are factory methods with different names and return values, but many common parameters. For example: SomeType1 *getSomeType1 (const std::string &name, int id); SomeType2 *getSomeType2 (const std::string &name,…
goug
  • 2,294
  • 1
  • 11
  • 15
1
vote
1 answer

Doxygen fails to use Graphviz to generate dependency graph

I am trying to use Doxygen to generate the documentation of my c++ program, and I wish to have the dependency graph as well. So I installed graphviz-2.40.1, the path to graphviz is shown below: which dot /usr/local/bin/dot I turned on the HAVE_DOT…
Shiqi He
  • 95
  • 3
  • 10
1
vote
0 answers

Doxygen Create Link to specific line of code

Before you reference in-doxygen-documentation-how-to-create-a-link-to-a-specific-line-of-a-file, I already reviewed that and it doesn't answer the question I have. In doxygen, there are several links created to specific lines of code (assuming code…
ls6777
  • 386
  • 1
  • 5
  • 14
1
vote
2 answers

Problem converting doxygen to latex to pdf

I have created a latex document from a c++ project using doxygen. After that, I have used pdflatex to convert the refman.tex document to pdf (I did this several times to ensure that all references were correctly completed). My problem is that in 2…
marpe
  • 185
  • 2
  • 9
1
vote
0 answers

How to add special tags to XML

I'm trying to make doxygen work for C# since I've used to document my libraries and C/C++ file. In order to stay consistent with the environment, I want to make custom XML tags for example : Copyright(c) to production firm all rights…
MAROUANE CHAABANI
  • 11
  • 2
1 2 3
…
99 100