[Bug libstdc++/40380] class documentation should mention include file to use

redi at gcc dot gnu.org gcc-bugzilla@gcc.gnu.org
Thu Jul 1 20:11:19 GMT 2021


https://gcc.gnu.org/bugzilla/show_bug.cgi?id=40380

--- Comment #5 from Jonathan Wakely <redi at gcc dot gnu.org> ---
If we do this for each class:

@class unique_ptr memory

and enable SHOW_INCLUDE_FILES=YES in the doxygen config, then we get this in
the docs for unique_ptr:

#include <memory>

It also seems to avoid the doxygen bug that causes @ingroup or @addtogroup to
be ignored for classes.

The downside is that SHOW_INCLUDE_FILES=YES also causes the docs for each file
to show a full list of all headers it includes:

#include <bits/c++config.h>
#include <bits/exception.h>
#include <bits/exception_ptr.h>
#include <bits/nested_exception.h>

I don't think we want to show those internal headers in the public API docs, so
I've asked for a way to avoid that:
https://github.com/doxygen/doxygen/issues/8639


More information about the Gcc-bugs mailing list