You can put example source code in a special path defined in the doxygen config under EXAMPLE_PATH, and then insert examples with the @example tag. Doxygen will then generate an extra page containing the source of the example. It will also set a link to it from the class documentation containing the example tag. Alternatively … Read more
The generalization of \bug and \todo is \xrefitem. The solution I suggest is: in Doxyfile: ALIASES += “req=\xrefitem req \”Requirement\” \”Requirements\” ” in documented code: /// \req #42 – The system shall work in any situation
With Doxygen 1.8.2, both the following work for me: Using /// /// This is an enum class enum class fooenum { FOO, ///< this is foo BAR, ///< this is bar }; Using /*! … */ /*! This is an enum class */ enum class fooenum { FOO, /*!< this is foo */ BAR, /*!< … Read more
See Converting a LaTeX document to a PDF document. When Doxygen is finished processing, in the latex directory there’s a file called ‘refman.tex’. There are three ways you can use that file to get ‘a book’ out of Doxygen: LaTeX -> dvips -> ps2pdf latex myfile dvips myfile ps2pdf myfile.ps LaTeX -> dvipdfm latex myfile … Read more
It’s a way for doxygen to generate documentation for members of a file/struct/union/class/enum. By using that marker, you can put comments after each member, leading to less clutter. You can read more about it here.
I was facing the same problem. There is an perl dependency to generate citation. So you must have both perl and bibtex in the system path. Ignore the example above, that only applies to Latex, for doxygen use (Note: no braces): \cite Hale The .bib file has to be located in doxygen working directory. Bibliographic … Read more
I have gotten it to work as follows: Use XML style comments for your C++/CLI header entries. This means the full XML comment is required (triple-slash comments, <summary> tag at a minimum) Make sure that the C++ compiler option Generate XML Documentation Files is on. This should generate an XML file with documentation with the … Read more
Create the following source file example.cpp: class Animal { public: void die(); string name; int age; }; class Dog : public Animal { public: void bark(); }; class Cat : public Animal { public: void meow(); }; run doxygen -g and change the following options of the generated Doxyfile: EXTRACT_ALL = YES HAVE_DOT = YES … Read more
You have to set HAVE_DOT, CALL_GRAPH and CALLER_GRAPH to YES. Also make sure the path to dot is in your PATH variable. If that still doesn’t work, you might have to set EXTRACT_ALL and/or EXTRACT_STATIC, depending on your functions.
I having been searching quite a lot before I found the answer, so I thought it would be nice to share! According to this Doxygen gotchas article I finally found that: you need to add a file with the dox extension. Its content should contain C-style comment blocks: /*! \page My test page contents … … Read more