Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Doxygen won't find headers in subdir

I'm documenting a C++ library's header files with Doxygen. In the Doxyfile, I defined

INPUT = include/

in the hopes that Doxygen would then generate documentation for all the header files in include/Foo, but it doesn't: only the index.html is generated. I can set INPUT to include/Foo, but then the documentation lists the headers with their basenames (Reader.hh), while I want clients to include the headers as Foo/Reader.hh etc.

How can I get Doxygen to look within the subdirectory?

like image 374
Fred Foo Avatar asked Dec 10 '10 13:12

Fred Foo


People also ask

Should Doxygen be in header or source?

The common sense tells that the Doxygen comment blocks have to be put in the header files where the classes, structs, enums, functions, declarations are. I agree that this is a sound argument for a libraries that are mean to be distributed without its source (only headers and libs with object code).

How to 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. This should be within the same file of course.


1 Answers

Have you set RECURSIVE to YES?

# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
# If left blank NO is used.

RECURSIVE              = YES

it's in the Doxyfile (here line 608, might be sligthly different for you)

like image 149
basti Avatar answered Oct 01 '22 05:10

basti