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
16
votes
1 answer

Doxygen report "potential recursive class relation"

I have a C++ templated class base::Foo, and I have in another file a class base::bar::Foo : public base::Foo. Doxygen seems not to like this, as it throws an error :1: Detected potential recursive class relation between class…
Seth Johnson
  • 14,762
  • 6
  • 59
  • 85
16
votes
11 answers

Graphviz for documentation

I noticed that doxygen uses the graphviz library for creating diagrams. Have you ever used graphviz for generating documentation? Is it worth learning the graphviz for documentation purposes outside the scope of doxygen? Or am I better off to…
Marcin
  • 12,245
  • 9
  • 42
  • 49
16
votes
2 answers

Could not find Doxygen (missing: DOXYGEN_EXECUTABLE) in Mac OS X

I want to install meta on my Mac OS X. I have OS X 10.9.3, and I received the following errors: DICU_ROOT=/usr/local/opt/icu4c -- Compiler supports C++1y (using it) -- Could NOT find Doxygen (missing: DOXYGEN_EXECUTABLE) -- Locating…
Mosafer Koochooloo
  • 189
  • 1
  • 1
  • 8
16
votes
3 answers

Getting shared_ptr refs to appear in doxygen collaboration diagrams

I've done enough Googling to know that if I have something like class SubObject { public: //blah blah blah }; class Aggregate { public: boost::shared_ptr m_ptr; }; I can get Doxygen to create the "correct" collaboration diagram if…
Eric H.
  • 2,566
  • 2
  • 23
  • 34
16
votes
5 answers

Doxygen 1.8.7 / GraphViz 2.38 compatabilty issue

I recently upgraded from Doxygen 1.8.4 and GraphViz 2.36 where I had no problems generating graphs to Doxygen 1.8.7 and GraphViz 2.38 and cannot now get graphs. During the build I get large numbers of errors of the form error: Problems running…
LarryB
  • 223
  • 1
  • 2
  • 9
16
votes
4 answers

doxygen and graphviz doesn't generate map files

I am trying Graphviz and doxygen on a rather large C++ library to generate UML. It generates the .dot files but then says it can't open the .map files. I am running doxygen 1.8.3 and 2.30.1 installed via the msi on Windows 7 64bit. I also manually…
user2632182
  • 161
  • 1
  • 1
  • 3
16
votes
1 answer

How to make doxygen preprocessor recurse into subdirectories?

I do not get the doxygen preprocessor to recursively include files. How to do this? I made up an example consisting of two headers and a Doxygen file: subdir/example.h subdir2/example_include.h Doxygen This is the listing of example.h: #include…
Jakob S.
  • 1,851
  • 2
  • 14
  • 29
15
votes
2 answers

How to include folder in doxygen documentation?

I want to include folder in doxygen documentation. I have tried \page and \include but it hasn't worked, does anyone know how to do it? Here is the tree : +root -+controllers --- category.php -+models --- categories.php - mainpage.php
Diani Chandra Pertiwi
  • 311
  • 2
  • 6
  • 14
15
votes
4 answers

Doxygen: hiding private/protected method...and tips

I am using Doxygen to generate documentation for our API, written in C#. However, it exposes private/protected members. Is there a way to hide those? I figured out how to hide files: EXCLUDE = List of file names Yet, I need more…
Sasha
15
votes
7 answers

Doxygen: how to describe class member variables in php?

I'm trying to use doxygen to parse php code into xml output. Doxygen does not parse description of class member variables. Here is my sample php file:
lost_guadelenn
  • 447
  • 4
  • 14
15
votes
3 answers

Doxygen for a project managed with git?

I'm working on a C++ and Objective C iPhone Project. I'm using git as my version control system. The codebase has been growing quite a bit, so I would like to add doxygen to the project. The problem is that I'm not sure about what would be the best…
Goles
  • 11,599
  • 22
  • 79
  • 140
15
votes
2 answers

Doxygen for C++ template class member specialization

When I write class templates, and need to fully-specialize members of those classes, Doxygen doesn't recognize the specialization - it documents only the generic definition, or (if there are only specializations) the last definition. Here's a simple…
Ziv
  • 2,369
  • 3
  • 24
  • 40
15
votes
1 answer

How can I force Doxygen to show full include path?

How can I force Doxygen to show full include path? What do I mean: I have a class foo::bar::bee defined in bee.hpp in following directory structure: foo foo/bar foo/bar/bee.hpp Doxygen, when it documents foo::bar::bee class tells that you need to…
Artyom
  • 31,019
  • 21
  • 127
  • 215
15
votes
5 answers

How do you order Doxygen Custom Pages

I have created a number of custom pages within Doxygen. I would like to customize the the order of the pages in the main menu. Below is a picture of my current navigation menu. I would like to change the order so Overview is first, Installation…
SchwartzE
  • 2,558
  • 5
  • 30
  • 39
15
votes
2 answers

Changing the location of the index.html file in Doxygen output

I'm using Doxygen to create html output. I'd like to customize the output so that the index.html file could be more noticeable, since at the moment it is buried half way down a huge list of files in the html output folder. For example, if it were…
user1488804
  • 840
  • 1
  • 13
  • 27
1 2 3
…
99 100