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

Documenting math formulas as comments in python code using Doxygen

my question is an extension of this one, and what i want is Doxygen to output the math formulas and text that are in the same comment line of my python source code. Let's take the following example: # Create homogeneous probability matrix from the…
José Brito
  • 13
  • 3
1
vote
0 answers

Doxygen documents function parameters in C as global variables

Using Doxygen 1.8.7, I've been asked to remove references to two global variables from a project's output. Looking at the source (a C header file), I found that the "global variables" aren't variables at all; they're function parameters! The header…
Jonathan Sachs
  • 613
  • 8
  • 19
1
vote
0 answers

Doxygen: How to link to another memeber function in doc block of a memeber function?

Like this, I've already used the…
Hossein Noroozpour
  • 1,091
  • 1
  • 13
  • 26
1
vote
2 answers

Problems using an external library (GEGELATI)

Recently I start to learn about machine learning and download a library that work with it: GEGELATI for C++, in Visual Studio. Link to the library: https://github.com/gegelati/gegelati. I also download the example "stick-game" from the same page. I…
Alexis Mercado
  • 29
  • 7
1
vote
0 answers

Doxygen warning about overloaded operator&= in c++ code

I have a с++ project that uses CMake to build. Doxygen is used as a documentation system. I have a warnings from Doxygen, and I can not understand why they appear. Warnings So, there are warnings: .../cnumber.cpp:413: warning: documented symbol…
Nikita
  • 11
  • 2
1
vote
0 answers

Tracing a Doxygen documentation page back to the source repo

Here's the problem: I need to create a Doxygen project that includes only the pages in one "chapter" of an existing project. To do that I need to know which of the existing project's source files generate those pages, and then which repo(s) the…
Jonathan Sachs
  • 613
  • 8
  • 19
1
vote
0 answers

Why can't Doxygen resolve most of the methods in my call graph?

Take a look at this call graph. Now look at the source of that function and all the calls to methods of InboundLedger, through the shared_ptr named inbound. Notice how the call graph mentions none of those methods. Notice how the…
John Freeman
  • 2,552
  • 1
  • 27
  • 34
1
vote
0 answers

Doxygen and C# ValueTuple

I am using Doxygen 1.8.17 to document a C# project and I am trying to document this: /// /// returns the LU factorization of a general m-by-n matrix A as: P*A = L*U. /// /// a matrix m-by-n public…
user2092113
  • 103
  • 1
  • 5
1
vote
0 answers

How to make doxygen display directory dependencies through function references instead of through include header files？

I am trying to document my C code using doxygen. If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the dependencies a directory has on other directories in a graphical way. The problem is that the dependency relations are determined…
BITscu
  • 11
  • 1
1
vote
1 answer

How do I place two images side by side in my doxygen mainpage

I am inexperienced with html so I am having trouble placing the images how I want (side by side). This is what I have in mainpage: 68 * \htmlonly …
John Hendrickson
  • 59
  • 6
1
vote
0 answers

How to get cpp Doxygen module list in Sphinx?

Using the defgroup Doxygen keyword in a Doxygen comment block, it is possible to define a "module". Then, using the ingroup Doxygen keyword in any other Doxygen comment block, even in other source files, it is possible to add cpp classes and enums…
jmarina
  • 333
  • 1
  • 2
  • 8
1
vote
0 answers

Separate Functions in Doxygen Documentation

I followed this tutorial and used the default Doxygen config-file: https://flcwiki.desy.de/How%20to%20document%20your%20code%20using%20doxygen I have a tests.cpp file that looks like this: /// \file #include "gtest/gtest.h" #include…
user12541823
1
vote
1 answer

Formatting For Parameters in Doxygen

I am using this method to document my methods: /** * Order beers from another player and add them into own inventory. * @params from The Player who has to deliver the order */ void Player::order(const int numberOfBeers, Player &from) { …
user12541823
1
vote
0 answers

How to generate Doxygen report based on *.dox and take only reference from the source code

We have a requirement to setup the doxygen report generation based only upon the .dox file. So that unnecessary changes to the source code file can be avoided for just updating doxygen comments. I hope this can be done as per our expectation in…
Akhil PK
  • 11
  • 2
1
vote
1 answer

Docker volume not working with Docker-compose to generate Doxygen documentation

I'm trying to generate a Doxygen documentation in a Dockerfile using a Docker-compose to run all the services at the same time. The goal is to generate the documentation in the container and to retrieve the generated files in local. Here is my…
Hugo Sohm
  • 2,872
  • 4
  • 23
  • 40
1 2 3
…
99 100