How to include only some source files in Doxygen-generated documentation?

Question

In my project, I'd like to scan all source files for documentation, but only include in the generated documentation the full source code for some source files (example code, for example).

Currently I've set SOURCE_BROWSER and VERBATIM_HEADERS to NO, so no source files are included.

Is there some way I can provide a list of source files I'd like to include despite those settings?

Or, if I turn those options back on, is there some way I can provide a list of source files to exclude?

http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_exclude — Robert Harvey, Jan 03 '13 at 21:39
@RobertHarvey: `EXCLUDE` and `EXCLUDE_PATTERNS`, if I understand correctly, both exclude the file altogether — the file is not scanned for documentation. But I'm looking for a way to extract the documentation from a file, without including the full source of the file in the generated documentation. — smokris, Jan 04 '13 at 01:22

score 7 · Accepted Answer · edited Dec 22 '18 at 13:20

7

There is no way to only specify a specific list of files that need to be processed with SOURCE_BROWSER enabled.

You can however include examples, see snippet, example, dontinclude, or verbinclude for various ways to do this.

edited Dec 22 '18 at 13:20

albert

8,285
3
19
32

answered Jan 04 '13 at 09:17

doxygen

14,341
2
43
37

Thanks; `\include` is what I needed, since it also highlights syntax and links to methods. – smokris Jan 05 '13 at 03:48

How to include only some source files in Doxygen-generated documentation?

1 Answers1