]> gcc.gnu.org Git - gcc.git/commit
libstdc++: Improvements to Doxygen markup
authorJonathan Wakely <jwakely@redhat.com>
Wed, 30 Jun 2021 23:30:54 +0000 (00:30 +0100)
committerJonathan Wakely <jwakely@redhat.com>
Thu, 1 Jul 2021 17:45:48 +0000 (18:45 +0100)
commitf2ce64b53fa76a4c192fe51b2f6c5a863a3b1241
tree4339fdd1187675dd694f0fa06e8ca5240f1f9cbb
parenta3d8860d6386cd12942bc0b1995765ea516297bd
libstdc++: Improvements to Doxygen markup

This attempst to improve the doxygen output to work around what seems to
be some bugs in doxygen (issues 8635 and 8638).

The @addtogroup command doesn't work for entities inside a nested
namespace (see 8635) so we need to close and reopen groups on entering
and elaving nested namespaces. This fixes the problem that
chrono::duration and chrono::time_point were not documented in the
"Time" documentation group. I am unable to make the path classes appear
as part of their relevant groups (File System and Filesystem TS), nor
the contents of <exception> or <system_error>. I have made some minor
improvements to the docs for those types, including starting to address
PR 97001 by adding @since to the doxygen comments.

This change also excludes the <experimental/bits/net.h> header from
Doxygen processing, so we don't get an unwanted "Networking-ts" group
in the documentation.

Signed-off-by: Jonathan Wakely <jwakely@redhat.com>
libstdc++-v3/ChangeLog:

* doc/doxygen/doxygroups.cc: Fix docs for std::literals.
* doc/doxygen/user.cfg.in: Exclude the Networking TS header.
Add some more predefined macros.
* include/bits/fs_fwd.h: Move @addtogroup commands inside
namespaces. Add better documentation.
* include/bits/fs_path.h: Likewise.
* include/experimental/bits/fs_fwd.h: Likewise.
* include/experimental/bits/fs_path.h: Likewise.
* include/ext/throw_allocator.h: Fix typo and improve docs.
* include/std/chrono: Move @addtogroup commands.
* include/std/system_error: Move @addtogroup commands.
* libsupc++/exception: Improve documentation.
* libsupc++/exception.h: Add @since documentation.
libstdc++-v3/doc/doxygen/doxygroups.cc
libstdc++-v3/doc/doxygen/user.cfg.in
libstdc++-v3/include/bits/fs_fwd.h
libstdc++-v3/include/bits/fs_path.h
libstdc++-v3/include/experimental/bits/fs_fwd.h
libstdc++-v3/include/experimental/bits/fs_path.h
libstdc++-v3/include/ext/throw_allocator.h
libstdc++-v3/include/std/chrono
libstdc++-v3/include/std/system_error
libstdc++-v3/libsupc++/exception
libstdc++-v3/libsupc++/exception.h
This page took 0.057631 seconds and 6 git commands to generate.