Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Exclude some classes from doxygen documentation

Tags:

doxygen

I am building a Qt based project, and many Qt classes are found in the target documentation.

How can I tell Doxygen to disable documentation generation for some classes? For Q.*?

like image 727
elcuco Avatar asked Sep 16 '09 17:09

elcuco


People also ask

How exclude code from doxygen?

How can I make doxygen ignore some code fragment? The new and easiest way is to add one comment block with a \cond command at the start and one comment block with a \endcond command at the end of the piece of code that should be ignored.

How do I use Doxywizard?

Using DoxywizardIn the Run tab choose Run Doxygen to generate the documentation. It will be produced in the format you chose: HTML, CHM, XML, RTF or many others. It is a good idea to save the configuration to a file named Doxyfile in the project directory. Do this in the Doxywizard by choosing File → Save As.

Does doxygen work with Java?

Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, and to some extent D.


2 Answers

Working under the assumption that what you have is something like this: (The question is a little unclear in this regard)

/**
 * Some documentation for class X
 */
class X: public osg::Drawable {
...
}

And your problem is that you want to include documentation for class X, but not for class osg::Drawable, the proper technique is to use EXCLUDE_SYMBOLS. For example, in the case above use

EXCLUDE_SYMBOLS = osg::Drawable

If you want to be slightly more rigorous, you can use

EXCLUDE_SYMBOLS = osg::Drawable \
                  Drawable

Wild-cards are also allowed, so this will also work

EXCLUDE_SYMBOLS = osg::*
like image 136
Ben Hocking Avatar answered Sep 20 '22 17:09

Ben Hocking


If \internal tag does not work, you can try \cond ... \endcond tags for marking a portion of code to be hidden from Doxygen.

EDIT

If you want to exclude specific files, you can use EXCLUDE_PATTERNS variable in Doxyfile configuration file.

like image 41
mouviciel Avatar answered Sep 21 '22 17:09

mouviciel