doxygen special command to ignore a file

Question

I am adding code to a large library that is documented with Doxygen. I wish for some of the files to not be included in the Doxygen documentation.

The doxyfile contains many controls to include and exclude specific files, but since many people contribute to this library I'd prefer to avoid modifying the doxyfile.

Are there any special commands that I can put into the files themselves, that instructs Doxygen to ignore the whole file?

Answer 1

You can't ignore a file by a special command, but you can exclude files from the documentation in the Doxygen configuration file (generally called Doxyfile) by adding the static or relative path to the file which shall be exculded to the EXCLUDE tag, e.g.:

EXCLUDE =  ./../lib/stdio.h

This way you can also exclude whole directories from the documentation:

EXCLUDE =  ./../lib

You can also use the EXCLUDE_PATTERNS tag and use wildcard patterns, e.g.:

EXCLUDE_PATTERNS = */test/*

Hope this helps.