aboutsummaryrefslogtreecommitdiff
path: root/libstdc++-v3/include/ext
diff options
context:
space:
mode:
authorBenjamin Kosnik <bkoz@redhat.com>2010-02-10 05:45:24 +0000
committerBenjamin Kosnik <bkoz@gcc.gnu.org>2010-02-10 05:45:24 +0000
commit0eb95b0d69b0f1cb862fe9f0021282a273c1ddd7 (patch)
tree20c4f88ab26e67ce8d55f69aece783ccac97217d /libstdc++-v3/include/ext
parent52f126782f91d7277e11864fb53d4d7eb769bcc2 (diff)
downloadgcc-0eb95b0d69b0f1cb862fe9f0021282a273c1ddd7.zip
gcc-0eb95b0d69b0f1cb862fe9f0021282a273c1ddd7.tar.gz
gcc-0eb95b0d69b0f1cb862fe9f0021282a273c1ddd7.tar.bz2
streambuf: Adjust doxygen group markup.
2010-02-09 Benjamin Kosnik <bkoz@redhat.com> * include/std/streambuf: Adjust doxygen group markup. * include/std/functional: Same. * include/ext/vstring.h: Same. * include/ext/pb_ds/assoc_container.hpp: Same. * include/ext/stdio_filebuf.h: Same. * include/ext/stdio_sync_filebuf.h: Same. * include/bits/localefwd.h: Same. * include/bits/functional_hash.h: Same. * include/bits/locale_classes.h: Same. * include/bits/locale_facets.h: Same. * include/bits/ios_base.h: Same. * include/bits/codecvt.h: Same. * include/bits/locale_facets_nonio.h: Same. * testsuite/27_io/ios_base/cons/assign_neg.cc: Adjust line numbers. * testsuite/27_io/ios_base/cons/copy_neg.cc: Same. From-SVN: r156644
Diffstat (limited to 'libstdc++-v3/include/ext')
-rw-r--r--libstdc++-v3/include/ext/pb_ds/assoc_container.hpp34
-rw-r--r--libstdc++-v3/include/ext/stdio_filebuf.h4
-rw-r--r--libstdc++-v3/include/ext/stdio_sync_filebuf.h9
-rw-r--r--libstdc++-v3/include/ext/vstring.h8
4 files changed, 41 insertions, 14 deletions
diff --git a/libstdc++-v3/include/ext/pb_ds/assoc_container.hpp b/libstdc++-v3/include/ext/pb_ds/assoc_container.hpp
index 7bccb88..dca953b 100644
--- a/libstdc++-v3/include/ext/pb_ds/assoc_container.hpp
+++ b/libstdc++-v3/include/ext/pb_ds/assoc_container.hpp
@@ -1,6 +1,6 @@
// -*- C++ -*-
-// Copyright (C) 2005, 2006, 2009 Free Software Foundation, Inc.
+// Copyright (C) 2005, 2006, 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the terms
@@ -49,10 +49,25 @@
namespace __gnu_pbds
{
+ /** @defgroup pbds Policy-Based Data Structures
+ * @ingroup extensions
+ *
+ * This is a library of policy-based elementary data structures:
+ * associative containers and priority queues. It is designed for
+ * high-performance, flexibility, semantic safety, and conformance
+ * to the corresponding containers in std (except for some points
+ * where it differs by design).
+ *
+ * For details, see:
+ * http://gcc.gnu.org/onlinedocs/libstdc++/ext/pb_ds/index.html
+ *
+ * @{
+ */
+
#define PB_DS_BASE_C_DEC \
detail::container_base_dispatch<Key, Mapped, Tag, Policy_Tl, Allocator>::type
- // An abstract basic associative container.
+ /// An abstract basic associative container.
template<typename Key,
typename Mapped,
typename Tag,
@@ -115,7 +130,7 @@ namespace __gnu_pbds
container_base<Key, Mapped, Tag, typename __gnu_cxx::typelist::append< \
typename __gnu_cxx::typelist::create4<Hash_Fn, Eq_Fn, Resize_Policy, detail::integral_constant<int, Store_Hash> >::type, Policy_TL>::type, Allocator>
- // An abstract basic hash-based associative container.
+ /// An abstract basic hash-based associative container.
template<typename Key,
typename Mapped,
typename Hash_Fn,
@@ -152,7 +167,7 @@ namespace __gnu_pbds
cc_hash_tag, \
typename __gnu_cxx::typelist::create1<Comb_Hash_Fn>::type, Allocator>
- // A concrete collision-chaining hash-based associative container.
+ /// A concrete collision-chaining hash-based associative container.
template<typename Key,
typename Mapped,
typename Hash_Fn = typename detail::default_hash_fn<Key>::type,
@@ -289,7 +304,7 @@ namespace __gnu_pbds
gp_hash_tag, \
typename __gnu_cxx::typelist::create2<Comb_Probe_Fn, Probe_Fn>::type, Allocator>
- // A concrete general-probing hash-based associative container.
+ /// A concrete general-probing hash-based associative container.
template<typename Key,
typename Mapped,
typename Hash_Fn = typename detail::default_hash_fn<Key>::type,
@@ -455,7 +470,7 @@ namespace __gnu_pbds
#define PB_DS_BASE_C_DEC \
container_base<Key, Mapped, Tag, Policy_Tl, Allocator>
- // An abstract basic tree-like (tree, trie) associative container.
+ /// An abstract basic tree-like (tree, trie) associative container.
template<typename Key, typename Mapped, typename Tag,
typename Node_Update, typename Policy_Tl, typename Allocator>
class basic_tree : public PB_DS_BASE_C_DEC
@@ -485,7 +500,7 @@ namespace __gnu_pbds
basic_tree<Key,Mapped,Tag,typename PB_DS_TREE_NODE_AND_IT_TRAITS_C_DEC::node_update, \
typename __gnu_cxx::typelist::create2<Cmp_Fn, PB_DS_TREE_NODE_AND_IT_TRAITS_C_DEC >::type, Allocator>
- // A concrete basic tree-based associative container.
+ /// A concrete basic tree-based associative container.
template<typename Key, typename Mapped, typename Cmp_Fn = std::less<Key>,
typename Tag = rb_tree_tag,
template<typename Const_Node_Iterator, typename Node_Iterator, typename Cmp_Fn_, typename Allocator_>
@@ -556,7 +571,7 @@ namespace __gnu_pbds
basic_tree<Key,Mapped,Tag, typename PB_DS_TRIE_NODE_AND_ITS_TRAITS::node_update, \
typename __gnu_cxx::typelist::create2<E_Access_Traits, PB_DS_TRIE_NODE_AND_ITS_TRAITS >::type, Allocator>
- // A concrete basic trie-based associative container.
+ /// A concrete basic trie-based associative container.
template<typename Key,
typename Mapped,
typename E_Access_Traits = typename detail::default_trie_e_access_traits<Key>::type,
@@ -629,7 +644,7 @@ namespace __gnu_pbds
container_base<Key, Mapped, list_update_tag, \
typename __gnu_cxx::typelist::create2<Eq_Fn, Update_Policy>::type, Allocator>
- // A list-update based associative container.
+ /// A list-update based associative container.
template<typename Key,
typename Mapped,
class Eq_Fn = typename detail::default_eq_fn<Key>::type,
@@ -678,6 +693,7 @@ namespace __gnu_pbds
#undef PB_DS_BASE_C_DEC
+ // @} group pbds
} // namespace __gnu_pbds
#endif
diff --git a/libstdc++-v3/include/ext/stdio_filebuf.h b/libstdc++-v3/include/ext/stdio_filebuf.h
index 6efe4ea..09c3c26 100644
--- a/libstdc++-v3/include/ext/stdio_filebuf.h
+++ b/libstdc++-v3/include/ext/stdio_filebuf.h
@@ -1,6 +1,7 @@
// File descriptor layer for filebuf -*- C++ -*-
-// Copyright (C) 2002, 2003, 2004, 2005, 2009 Free Software Foundation, Inc.
+// Copyright (C) 2002, 2003, 2004, 2005, 2009, 2010
+// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
@@ -37,6 +38,7 @@ _GLIBCXX_BEGIN_NAMESPACE(__gnu_cxx)
/**
* @brief Provides a layer of compatibility for C/POSIX.
+ * @ingroup io
*
* This GNU extension provides extensions for working with standard C
* FILE*'s and POSIX file descriptors. It must be instantiated by the
diff --git a/libstdc++-v3/include/ext/stdio_sync_filebuf.h b/libstdc++-v3/include/ext/stdio_sync_filebuf.h
index de44fdc..84a8c26 100644
--- a/libstdc++-v3/include/ext/stdio_sync_filebuf.h
+++ b/libstdc++-v3/include/ext/stdio_sync_filebuf.h
@@ -43,7 +43,14 @@
_GLIBCXX_BEGIN_NAMESPACE(__gnu_cxx)
- /// class stdio_sync_filebuf.
+ /**
+ * @brief Provides a layer of compatibility for C.
+ * @ingroup io
+ *
+ * This GNU extension provides extensions for working with standard
+ * C FILE*'s. It must be instantiated by the user with the type of
+ * character used in the file stream, e.g., stdio_filebuf<char>.
+ */
template<typename _CharT, typename _Traits = std::char_traits<_CharT> >
class stdio_sync_filebuf : public std::basic_streambuf<_CharT, _Traits>
{
diff --git a/libstdc++-v3/include/ext/vstring.h b/libstdc++-v3/include/ext/vstring.h
index 37d36bc..721af00 100644
--- a/libstdc++-v3/include/ext/vstring.h
+++ b/libstdc++-v3/include/ext/vstring.h
@@ -41,10 +41,12 @@ _GLIBCXX_BEGIN_NAMESPACE(__gnu_cxx)
/**
* @class __versa_string vstring.h
- * @brief Managing sequences of characters and character-like objects.
+ * @brief Template class __versa_string.
+ * @ingroup extensions
+ *
+ * Data structure managing sequences of characters and
+ * character-like objects.
*/
-
- // Template class __versa_string
template<typename _CharT, typename _Traits, typename _Alloc,
template <typename, typename, typename> class _Base>
class __versa_string