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 extract the public interface from a large codebase

Given a large C++/C# codebase, what's the best way to pull out just the public interface from all the code? The intent is to have a more automated way to alert when something public facing has changed. So public classes, method, properties,…
Nerdtron
  • 1,486
  • 19
  • 32
1
vote
0 answers

clang tidy incorrectly parsing doxygen comment

In code that uses doxygen comments, we have this: /// @see @ref Foo::Bar() This generates a "See also" section in doxygen with an explicit link to the Foo::Bar() class/method. But with clang-tidy, this comment generates an error: example.h:70:12:…
Stéphane
  • 19,459
  • 24
  • 95
  • 136
1
vote
0 answers

Is there a way to use dot-files generated with Doxygen in Sphinx?

I am currently in a transition from Doxygen to Sphinx, as it looks much better and writing documentation feels better to me. However, I am trying to include graphs generated by Doxygen in my Sphinx documentation, as the autodoc-extension only…
DeerFreak
  • 105
  • 6
1
vote
0 answers

Doxygen: How to enable automated Referenced-By list

when I create a @page P1 and I @ref this page in some other page P2 then want to have an automatically added list of references on P1 which gives me a link to P2. Is this possible somehow? I was hoping the REFERENCED_BY_RELATION setting would do…
Daniel
  • 403
  • 2
  • 15
1
vote
1 answer

Doxygen's double hash-tags / number-signs (##) are not PEP8 conform (E266)

To document class members in Python for Doxygen you have to annotate them with two number-signs / hash-tags (##). class Foo: def __init__(self): ## This is a public member self.bar = 7 But PEP8 code checkers (e.g. pycodestyle) take this…
buhtz
  • 10,774
  • 18
  • 76
  • 149
1
vote
0 answers

Writing Doxygen documentation for a Fortran module interface

Is it possible to document Fortran interface via Doxygen? My extensive search has led me to believe that it is possible. But there does not seem to exist any clues on the web as to how this is possible. As an example consider the following interface…
Scientist
  • 1,767
  • 2
  • 12
  • 20
1
vote
1 answer

how in doxygen tell a function param should be certain define directive

I have some legacy function that in the input only accept some int. how properly document them and tell that the input of the function can be only one of the defined items? #define API_TYPE1 0 #define API_TYPE2 1 /** * @param[in] argument1 can be…
Mohammad Hossein Amri
  • 1,842
  • 2
  • 23
  • 43
1
vote
1 answer

Doxygen: \include test.dox in mainpage.dox adds as a text

I have created a Doxygne documentation for a python project. In-order to add a high level introduction about the project with a high level class architecture, I created a mainpage.dox file which has the following format. /* \mainpage #…
radar101
  • 67
  • 10
1
vote
1 answer

Why doxygen does not show annotated public attributes?

I am a newcomer and try to use doxygen for generate documentation. I use annotation for public attributes of classes to avoid type problems. But for a simple code: class doxygenchk: def __init__(self): self.attr: float = 1. …
Márton Markó
  • 11
  • 2
1
vote
0 answers

Does sphinx have something similar to doxygen's \page?

Doxygen has the \page directive which creates a standalone page in the resulting documentation. Does Sphinx have something similar?
arne
  • 4,514
  • 1
  • 28
  • 47
1
vote
1 answer

Autonumbering equations in doxygen

Is is possible to number automatic number equations in doxygen markdown documentation? Example: page1.md: This is Equation 1: \f[ \label{Eq:1} \bbox[Pearl, 10px,border:1px solid black] { \rho = \frac{m}{V} } \f] If I put a…
Manuel Oliveira
  • 527
  • 5
  • 19
1
vote
1 answer

Use base class Doxygen comment for overridden methods in derived classes

Using Visual Studio 2019 and C# (and new to Doxygen). Is it possible for a Doxygen comment from the base class method to be "applied" in Intellisense for derived classes (without actually having to write a Doxygen comment block for the method in the…
AlainD
  • 5,413
  • 6
  • 45
  • 99
1
vote
1 answer

Doxygen: How to reference a README.md file from my main page

I have a project structured like this. OpenRGB-cppSDK doc Doxyfile main.md -- Doxygen main page examples .cpp files with examples include public .hpp files src .hpp and .cpp files tools cli demo README.md --…
Youda008
  • 1,788
  • 1
  • 17
  • 35
1
vote
0 answers

How to write bare doxygen without source code?

I'm going to write documentation for some script API bindings (Lua actually), so there's no source code at all. How can I do that? I've tried to write bare doxygen like this: \page My API document \class BindedClassA \brief descriptions on it \var…
jiandingzhe
  • 1,881
  • 15
  • 35
1
vote
0 answers

Make Doxygen recognize "return value hints"

In my current project I defined some macros that serve as hints for parameters, return values and the relationship between them. For example notnull is for pointers that are not null. But there are also parameterized hints, like issizeof(__T) to…
Formal_Coder
  • 11
  • 1
1 2 3
…
99 100