Improve docs for Filesystem TS

	* include/experimental/bits/fs_dir.h: Fix Doxygen markup.
	* include/experimental/bits/fs_fwd.h: Improve docs.
	* include/experimental/bits/fs_ops.h: fix Doxygen markup.
	* include/experimental/bits/fs_path.h: Likewise.
	(path, filesystem_error, u8path): Improve docs.
	* include/experimental/filesystem: Link to docs for TS.

From-SVN: r270808

diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog
index 8b15504840c2a667a21664b527dd9bd9abe84096..b22563dcb826c863ab75f419c1b49d8088cb71d5 100644 (file)
--- a/libstdc++-v3/ChangeLog
+++ b/libstdc++-v3/ChangeLog
@@ -1,5 +1,12 @@
 2019-05-02  Jonathan Wakely  <jwakely@redhat.com>
 
+       * include/experimental/bits/fs_dir.h: Fix Doxygen markup.
+       * include/experimental/bits/fs_fwd.h: Improve docs.
+       * include/experimental/bits/fs_ops.h: fix Doxygen markup.
+       * include/experimental/bits/fs_path.h: Likewise.
+       (path, filesystem_error, u8path): Improve docs.
+       * include/experimental/filesystem: Link to docs for TS.
+
        * config/allocator/new_allocator_base.h (__allocator_base): Add
        workaround for Doxygen bug #6945.
        * include/std/memory: Improve docs. Define group for pointer safety.

diff --git a/libstdc++-v3/include/experimental/bits/fs_dir.h b/libstdc++-v3/include/experimental/bits/fs_dir.h
index 8e6475c48c4d057df698c23bc8e3edc93b54ae5f..3848e0c9d8cab67ba72bb7474b35984ec3a1d76b 100644 (file)
--- a/libstdc++-v3/include/experimental/bits/fs_dir.h
+++ b/libstdc++-v3/include/experimental/bits/fs_dir.h
@@ -49,7 +49,7 @@ namespace filesystem
 inline namespace v1
 {
   /**
-   * @ingroup filesystem-ts
+   * @addtogroup filesystem-ts
    * @{
    */
 

diff --git a/libstdc++-v3/include/experimental/bits/fs_fwd.h b/libstdc++-v3/include/experimental/bits/fs_fwd.h
index 97fe39f931de0b6f2b30f0bfc3916921b25ea7b1..87f7be973a2da904589bab9a21469ce120824fb3 100644 (file)
--- a/libstdc++-v3/include/experimental/bits/fs_fwd.h
+++ b/libstdc++-v3/include/experimental/bits/fs_fwd.h
@@ -59,6 +59,7 @@ inline namespace __cxx11 __attribute__((__abi_tag__ ("cxx11"))) { }
    * Utilities for performing operations on file systems and their components,
    * such as paths, regular files, and directories.
    *
+   * ISO/IEC TS 18822:2015     C++ File System Technical Specification
    * @{
    */
 

diff --git a/libstdc++-v3/include/experimental/bits/fs_ops.h b/libstdc++-v3/include/experimental/bits/fs_ops.h
index 096b275e9635c4605df4e6a4d4e9ae0d258c0185..492c6caab26fc688a9254eb64b404436ffba49f3 100644 (file)
--- a/libstdc++-v3/include/experimental/bits/fs_ops.h
+++ b/libstdc++-v3/include/experimental/bits/fs_ops.h
@@ -47,7 +47,7 @@ namespace filesystem
 inline namespace v1
 {
   /**
-   * @ingroup filesystem-ts
+   * @addtogroup filesystem-ts
    * @{
    */
 

diff --git a/libstdc++-v3/include/experimental/bits/fs_path.h b/libstdc++-v3/include/experimental/bits/fs_path.h
index c7b22f295690fe24b45587b646af747964a312d4..fafc9930a5bc8d8bbdb5239ebeedafb23bbabfb1 100644 (file)
--- a/libstdc++-v3/include/experimental/bits/fs_path.h
+++ b/libstdc++-v3/include/experimental/bits/fs_path.h
@@ -72,7 +72,7 @@ _GLIBCXX_BEGIN_NAMESPACE_CXX11
 #endif
 
   /**
-   * @ingroup filesystem-ts
+   * @addtogroup filesystem-ts
    * @{
    */
 
@@ -399,6 +399,7 @@ _GLIBCXX_BEGIN_NAMESPACE_CXX11
     iterator begin() const;
     iterator end() const;
 
+    /// @cond undocumented
     // Create a basic_string by reading until a null character.
     template<typename _InputIterator,
             typename _Traits = std::iterator_traits<_InputIterator>,
@@ -412,6 +413,7 @@ _GLIBCXX_BEGIN_NAMESPACE_CXX11
          __str.push_back(__ch);
        return __str;
       }
+    /// @endcond
 
   private:
     enum class _Type : unsigned char {
@@ -510,6 +512,8 @@ _GLIBCXX_BEGIN_NAMESPACE_CXX11
     _Type _M_type = _Type::_Multi;
   };
 
+  /// @relates std::experimental::filesystem::path @{
+
   inline void swap(path& __lhs, path& __rhs) noexcept { __lhs.swap(__rhs); }
 
   size_t hash_value(const path& __p) noexcept;
@@ -571,6 +575,7 @@ _GLIBCXX_BEGIN_NAMESPACE_CXX11
       return __is;
     }
 
+  /// Create a path from a UTF-8-encoded sequence of char
   // TODO constrain with _Path<Source> and __value_type_is_char
   template<typename _Source>
     inline path
@@ -583,6 +588,7 @@ _GLIBCXX_BEGIN_NAMESPACE_CXX11
 #endif
     }
 
+  /// Create a path from a UTF-8-encoded sequence of char
   // TODO constrain with _Path<InputIterator, InputIterator> and __value_type_is_char
   template<typename _InputIterator>
     inline path
@@ -595,6 +601,9 @@ _GLIBCXX_BEGIN_NAMESPACE_CXX11
 #endif
     }
 
+  /// @}
+
+  /// Exception type thrown by the Filesystem TS library
   class filesystem_error : public std::system_error
   {
   public:
@@ -624,6 +633,7 @@ _GLIBCXX_BEGIN_NAMESPACE_CXX11
     std::string _M_what = _M_gen_what();
   };
 
+  /// @cond undocumented
   struct path::_Cmpt : path
   {
     _Cmpt(string_type __s, _Type __t, size_t __pos)
@@ -732,6 +742,7 @@ _GLIBCXX_BEGIN_NAMESPACE_CXX11
                  __gnu_cxx::__normal_iterator<_Iter, _Cont> __last)
        { return _S_convert(__first.base(), __last.base()); }
     };
+  /// @endcond
 
   /// An iterator for the components of a path
   class path::iterator

diff --git a/libstdc++-v3/include/experimental/filesystem b/libstdc++-v3/include/experimental/filesystem
index 8bd044233a819f0a455fb64484ec87227e1059b9..016c4cf80a8712faa259d845abf68964e2dfcc5f 100644 (file)
--- a/libstdc++-v3/include/experimental/filesystem
+++ b/libstdc++-v3/include/experimental/filesystem
@@ -24,6 +24,7 @@
 
 /** @file experimental/filesystem
  *  This is a TS C++ Library header.
+ *  @ingroup filesystem-ts
  */
 
 #ifndef _GLIBCXX_EXPERIMENTAL_FILESYSTEM