Improve Doxygen docs for nested namespaces
authorJonathan Wakely <jwakely@redhat.com>
Thu, 2 May 2019 15:44:55 +0000 (16:44 +0100)
committerJonathan Wakely <redi@gcc.gnu.org>
Thu, 2 May 2019 15:44:55 +0000 (16:44 +0100)
* doc/doxygen/doxygroups.cc (std::tr2, std::__gnu_cxx): Improve docs.
(std::experimental): Add docs.
* doc/doxygen/user.cfg.in (PREDEFINED): Expand macros for __cxx11
namespace to nothing when generating docs.
* include/bits/regex_constants.h (std::regex_constants): Improve docs.
* include/std/chrono (std::chrono): Likewise.
* include/std/functional (std::placeholders): Likewise.
* include/std/thread (std::this_thread): Likewise.

From-SVN: r270805

libstdc++-v3/ChangeLog
libstdc++-v3/doc/doxygen/doxygroups.cc
libstdc++-v3/doc/doxygen/user.cfg.in
libstdc++-v3/include/bits/regex_constants.h
libstdc++-v3/include/std/chrono
libstdc++-v3/include/std/functional
libstdc++-v3/include/std/thread

index 0a018276cb378fbec2306d38952649f87bf5379c..a6469868368fc4db4dd5c11de3be354fd828a85f 100644 (file)
@@ -1,5 +1,14 @@
 2019-05-02  Jonathan Wakely  <jwakely@redhat.com>
 
+       * doc/doxygen/doxygroups.cc (std::tr2, std::__gnu_cxx): Improve docs.
+       (std::experimental): Add docs.
+       * doc/doxygen/user.cfg.in (PREDEFINED): Expand macros for __cxx11
+       namespace to nothing when generating docs.
+       * include/bits/regex_constants.h (std::regex_constants): Improve docs.
+       * include/std/chrono (std::chrono): Likewise.
+       * include/std/functional (std::placeholders): Likewise.
+       * include/std/thread (std::this_thread): Likewise.
+
        * include/parallel/settings.h: Fix Doxygen markup.
 
        * include/ext/pb_ds/detail/bin_search_tree_/*_imps.hpp: Do not define
index 6a6f6eb1d92318c437d04f0a329d2295bccd4078..6822eac8070dc652c0cde4cbd7175574618276fe 100644 (file)
  *  @brief Implementation details not part of the namespace std::tr1 interface.
 */
 /** @namespace std::tr2
- *  @brief ISO C++ TR2 entities toplevel namespace is std::tr2.
+ *  @brief Namespace for non-standard "TR2" extensions.
+ *  @ingroup extensions
 */
 /** @namespace std::tr2::__detail
  *  @brief Implementation details not part of the namespace std::tr2 interface.
 */
 /** @namespace __gnu_cxx
  *  @brief GNU extensions for public use.
+ *  @ingroup extensions
 */
 /** @namespace __gnu_cxx::__detail
  *  @brief Implementation details not part of the namespace __gnu_cxx 
@@ -45,6 +47,9 @@
  *  @brief GNU implemenation details, not for public use or
  *  export. Used only when anonymous namespaces cannot be substituted.
 */
+/** @namespace std::experimental
+ *  @brief Namespace for features defined in ISO Technical Specifications.
+ */
 // // // // // // // // // // // // // // // // // // // // // // // //
 
 /**
index 47fead334a10d9fdb04644952c6067a0975e4a33..c0b45b293c210fb0961053080e40d9dcc59d747b 100644 (file)
@@ -2265,10 +2265,12 @@ PREDEFINED             = __cplusplus=201402L \
                          "_GLIBCXX_BEGIN_NAMESPACE_VERSION= " \
                          "_GLIBCXX_BEGIN_NAMESPACE_ALGO= " \
                          "_GLIBCXX_BEGIN_NAMESPACE_CONTAINER= " \
+                         "_GLIBCXX_BEGIN_NAMESPACE_CXX11= " \
                          "_GLIBCXX_BEGIN_NAMESPACE_LDBL= " \
                          "_GLIBCXX_END_NAMESPACE_VERSION= " \
                          "_GLIBCXX_END_NAMESPACE_ALGO= " \
                          "_GLIBCXX_END_NAMESPACE_CONTAINER= " \
+                         "_GLIBCXX_END_NAMESPACE_CXX11= " \
                          "_GLIBCXX_END_NAMESPACE_LDBL= " \
                          "_GLIBCXX_TEMPLATE_ARGS=...  " \
                          _GLIBCXX_DEPRECATED \
@@ -2290,6 +2292,7 @@ PREDEFINED             = __cplusplus=201402L \
                          PB_DS_DATA_TRUE_INDICATOR \
                          PB_DS_STATIC_ASSERT=// \
                          "_GLIBCXX_BEGIN_NAMESPACE_ALGO= " \
+                         "_GLIBCXX_END_NAMESPACE_ALGO= " \
                          __glibcxx_function_requires=// \
                          __glibcxx_class_requires=// \
                          __glibcxx_class_requires2=// \
index a7b51ddef20bd51dcb25399e0ae1feb41ebe67fa..ba98d128e5e05d8693188ce73108a43c07a07d78 100644 (file)
@@ -43,7 +43,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
 
 /**
  * @namespace std::regex_constants
- * @brief ISO C++-0x entities sub namespace for regex.
+ * @brief ISO C++ 2011 namespace for options and flags used with std::regex
  */
 namespace regex_constants
 {
index 9e63fa9c6984b45d79c0c674742a92804e006c47..1d6326cdd55280fb75dd2fc2bac4396771cc3126 100644 (file)
@@ -54,7 +54,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
    */
 
   /** @namespace std::chrono
-   *  @brief ISO C++ 2011 entities sub-namespace for time and date.
+   *  @brief ISO C++ 2011 namespace for date and time utilities
    */
   namespace chrono
   {
index 8cf2c670648e51501e364e398337ef3f91d6c0b6..0c290b9670b29c9650b0c1273348058d5fdb36ff 100644 (file)
@@ -199,7 +199,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
   template<int _Num> struct _Placeholder { };
 
   /** @namespace std::placeholders
-   *  @brief ISO C++11 entities sub-namespace for functional.
+   *  @brief ISO C++ 2011 namespace for std::bind placeholders.
    *  @ingroup binders
    */
   namespace placeholders
index 4eb744d415250e9a7c126ce8fce31aadd6ece1a9..2da1101eecf9f5949bc62066d51afe3b2af61795 100644 (file)
@@ -328,8 +328,9 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
     }
 
   /** @namespace std::this_thread
-   *  @brief ISO C++ 2011 entities sub-namespace for thread.
-   *  30.3.2 Namespace this_thread.
+   *  @brief ISO C++ 2011 namespace for interacting with the current thread
+   *
+   *  C++11 30.3.2 [thread.thread.this] Namespace this_thread.
    */
   namespace this_thread
   {