Question

I want to document a library with doxygen. The documentation will be read by two classes of people: Users, which are only interested in the external API and developers which want to see documentation for all functions/structures.

I would like to use to separate doxyfiles to create the documentation. Is there some “tag” I can put in a comment block to mark a comment as internal/external?

Answer 1

Set INTERNAL_DOCS:

# The INTERNAL_DOCS tag determines if documentation
# that is typed after a \internal command is included. If the tag is set
# to NO (the default) then the documentation will be excluded.
# Set it to YES to include the internal documentation.

INTERNAL_DOCS          = NO

In the documentation, you can use \internal or @internal at whatever granularity you want (file, function, etc.).