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

merging multiple graphviz DOT files in Windows for gvpack

I have a large C codebase for which I had to generate Call graphs. I was kind of successful using Doxygen, but the problem now is, Doxygen generates a different DOT file for every function etc,.. I found another tool within GraphViz called gvpack…
Hari Krishna
  • 551
  • 6
  • 21
1
vote
0 answers

How to extract Call Graph(Collaboration diagram) details from xml?

I used doxygen on my java source code to generate call graphs and collaboration diagrams. My goal is to get data shown in collaboration diagrams to xml format. What I need is the data flow in my source code i.e. interactions between one class to…
Darshan
  • 11
  • 1
1
vote
0 answers

How can I use INPUT as INCLUDE_PATH in Doxygen configuration?

I have a C project with the subdirectories lib1 and lib2. lib2 defines things depending on defines in lib1. Therefore I set INPUT = lib1 lib2. I don't want to repeat the folders for INCLUDE_PATH (because in reality these are a lot of folders). I…
HeLLoTIS
  • 73
  • 6
1
vote
0 answers

Doxygen member groups and type hints with doxypypy in Python code

I'm using doxygen in combination with doxypypy to document Python source code. class Test: """ This is a test class. The thest class only serves the purpose of a MWE. Attributes: memberA (int): This is member A. …
LCsa
  • 607
  • 9
  • 30
1
vote
1 answer

how to get doxygen to see documentation of preprocessor macro in .F90 file?

I am working with the ParallelIO library, a free software library for high performance computing (HPC) I/O with a netCDF-like API. In some fortran code I have a file called piolib_mod.F90 that starts: !> !! @file !! @brief Initialization Routines…
Edward Hartnett
  • 882
  • 7
  • 16
1
vote
0 answers

How to combine a wiki page into doxygen output

I have a URI to a wiki page that I want to combine with my doxygen output. How should I should modify my Doxyfile to pull in the wiki's markdown file? How can I give the URI to the wiki to my Doxyfile, so that I do not have to maintain a repo-level…
ggg123
  • 99
  • 10
1
vote
0 answers

doxygen relative image paths and source directory structure

I use doxygen for documentation, and I have my sources under git. I want paths in my documentation to be relative to the project dir, as I check it out in different places. As the html subdir is generated by doxygen, it is not under version…
Zane
  • 926
  • 8
  • 21
1
vote
0 answers

Remove leading indentation/white space in doxygen \snippet

I'm using the \snippet examples.cpp xml_map::fixup command in doxygen 1.8.14 to generate the following... Which is derived from the following unit test code... TEST_METHOD(fixup) { /// [xml_map::fixup] // The source xml, but…
John Stritenberger
  • 1,194
  • 1
  • 12
  • 30
1
vote
2 answers

How to parse a C/C++ header file by doxygen(Now to invoke doxygen's API?)

I commented my source file with doxygen syntax, example: /** * @brief get Root tree */ void get() {} Now I want to get the function's brief message by doxygen's API, who can help me how to do it?
Liang Wul
  • 1,349
  • 2
  • 9
  • 5
1
vote
1 answer

How to show C++ style include syntax in doxygen

I am putting doxygen comment in my file. When I generat HTML files (using doxygen application) I can see MyClass Class Reference #include Which I want to display like MyClass Class Reference #include I tried various…
Jai
  • 1,292
  • 4
  • 21
  • 41
1
vote
1 answer

clang-format breaking long doxygen comments

I got this doxygen comments in my legacy codebase and I like to keep them for consistency. /***************//**************************************************************** * * @file * * Serial inteface to Novatel OEM4 GPS API. * …
eimer
  • 81
  • 7
1
vote
0 answers

Classes with @cond are showing when HIDE_UNDOC_MEMBERS is set to YES

I have the follow lines set in my .doxy file: EXTRACT_ALL = NO HIDE_UNDOC_MEMBERS = YES HIDE_UNDOC_CLASSES = YES My c# classes have this structure: public class Foo { public Bar bar { get; set; } ... } // @cond…
Chris
  • 1,163
  • 3
  • 13
  • 22
1
vote
2 answers

Doxygen (or other tool) document classes and namespaces similarly if at the same level

I have a bunch of namespaces (containing free functions) and classes (containing member functions, obviously), each of which has a Doxygen comment at the top level and some Doxygen comments for its members. They're within a top-level namespace (one…
Arthur Tacca
  • 8,833
  • 2
  • 31
  • 49
1
vote
0 answers

Is it possible to group up xml documentation from list tag in C#

I'm using Doxygen for my C# project documentation. And now I need to make one method's documentation with table. MSDN documentation is very poor about this tag : https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/list If I use…
KamikyIT
  • 314
  • 2
  • 15
1
vote
0 answers

Is post-condition of the function valid in all cases or only if the function is successful?

Let's say I have a following function: int reserve(DmaChannel& channel, const uint8_t request) { const auto ret = channel.reserve(request); if (ret != 0) return ret; channel_ = &channel; return 0; } It is clearly visible,…
Freddie Chopin
  • 8,440
  • 2
  • 28
  • 58
1 2 3
…
99
100