]> gcc.gnu.org Git - gcc.git/commit
libstdc++: Improve doxygen docs for <regex>
authorJonathan Wakely <jwakely@redhat.com>
Thu, 12 May 2022 11:16:17 +0000 (12:16 +0100)
committerJonathan Wakely <jwakely@redhat.com>
Fri, 13 May 2022 12:32:22 +0000 (13:32 +0100)
commit1b01963a4ea87607f5af6578a49006c8fee4d527
treea68a15d0e2fef4a965b3e71d7507a19248bb760a
parent1566ca0969ac4a14f7434d710e75dd89da303e75
libstdc++: Improve doxygen docs for <regex>

Add @headerfile and @since tags. Improve grouping of non-member
functions via @relates tags.

Mark the std::pair base class of std::sub_match as undocumented, so that
the docs don't show all the related non-member functions are part of the
sub_match API. Use a new macro to re-add the data members for Doxygen
only.

libstdc++-v3/ChangeLog:

* doc/doxygen/user.cfg.in (PREDEFINED): Define macro
_GLIBCXX_DOXYGEN_ONLY to expand its argument.
* include/bits/c++config (_GLIBCXX_DOXYGEN_ONLY): Define.
* include/bits/regex.h: Improve doxygen docs.
* include/bits/regex_constants.h: Likewise.
* include/bits/regex_error.h: Likewise.
libstdc++-v3/doc/doxygen/user.cfg.in
libstdc++-v3/include/bits/c++config
libstdc++-v3/include/bits/regex.h
libstdc++-v3/include/bits/regex_constants.h
libstdc++-v3/include/bits/regex_error.h
This page took 0.057801 seconds and 6 git commands to generate.