mirrors/gcc
0
0
Fork 0
mirror of https://gcc.gnu.org/git/gcc.git synced 2025-01-07 11:33:45 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve docs for Filesystem TS

Browse Source 
* 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
This commit is contained in:
Jonathan Wakely 2019-05-02 16:45:32 +01:00 committed by Jonathan Wakely
parent c05ab418b3
commit caace30081
6 changed files with 23 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
libstdc++-v3/ChangeLog
View File

@ -1,5 +1,12 @@
2019-05-02 Jonathan Wakely <jwakely@redhat.com> 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 * config/allocator/new_allocator_base.h (__allocator_base): Add
workaround for Doxygen bug #6945. workaround for Doxygen bug #6945.
* include/std/memory: Improve docs. Define group for pointer safety. * include/std/memory: Improve docs. Define group for pointer safety.

2
libstdc++-v3/include/experimental/bits/fs_dir.h
View File

@ -49,7 +49,7 @@ namespace filesystem
inline namespace v1 inline namespace v1
{ {
/** /**
* @ingroup filesystem-ts * @addtogroup filesystem-ts
* @{ * @{
*/ */

1
libstdc++-v3/include/experimental/bits/fs_fwd.h
View File

@ -59,6 +59,7 @@ inline namespace __cxx11 __attribute__((__abi_tag__ ("cxx11"))) { }
* Utilities for performing operations on file systems and their components, * Utilities for performing operations on file systems and their components,
* such as paths, regular files, and directories. * such as paths, regular files, and directories.
* *
* ISO/IEC TS 18822:2015 C++ File System Technical Specification
* @{ * @{
*/ */

2
libstdc++-v3/include/experimental/bits/fs_ops.h
View File

@ -47,7 +47,7 @@ namespace filesystem
inline namespace v1 inline namespace v1
{ {
/** /**
* @ingroup filesystem-ts * @addtogroup filesystem-ts
* @{ * @{
*/ */

13
libstdc++-v3/include/experimental/bits/fs_path.h
View File

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

1
libstdc++-v3/include/experimental/filesystem
View File

@ -24,6 +24,7 @@
/** @file experimental/filesystem /** @file experimental/filesystem
* This is a TS C++ Library header. * This is a TS C++ Library header.
* @ingroup filesystem-ts
*/ */
#ifndef _GLIBCXX_EXPERIMENTAL_FILESYSTEM #ifndef _GLIBCXX_EXPERIMENTAL_FILESYSTEM