libstdc++

doxygroups.cc
1 /*
2 Copyright (C) 2001-2013 Free Software Foundation, Inc.
3 See license.html for license.
4
5 This just provides documentation for stuff that doesn't need to be in the
6 source headers themselves. It is a ".cc" file for the sole cheesy reason
7 that it triggers many different text editors into doing Nice Things when
8 typing comments. However, it is mentioned nowhere except the *cfg.in files.
9
10 Some actual code (declarations) is exposed here, but no compiler ever
11 sees it. The decls must be visible to doxygen, and sometimes their real
12 declarations are not visible, or not visible in a way we want.
13
14 Pieces separated by '// //' lines will usually not be presented to the
15 user on the same page.
16 */
17
18 // // // // // // // // // // // // // // // // // // // // // // // //
19 /** @namespace std
20 * @brief ISO C++ entities toplevel namespace is std.
21 */
22 /** @namespace std::__detail
23 * @brief Implementation details not part of the namespace std interface.
24 */
25 /** @namespace std::tr1
26 * @brief ISO C++ TR1 entities toplevel namespace is std::tr1.
27 */
28 /** @namespace std::tr1::__detail
29 * @brief Implementation details not part of the namespace std::tr1 interface.
30 */
31 /** @namespace std::tr2
32 * @brief ISO C++ TR2 entities toplevel namespace is std::tr2.
33 */
34 /** @namespace std::tr2::__detail
35 * @brief Implementation details not part of the namespace std::tr2 interface.
36 */
37 /** @namespace __gnu_cxx
38 * @brief GNU extensions for public use.
39 */
40 /** @namespace __gnu_cxx::__detail
41 * @brief Implementation details not part of the namespace __gnu_cxx
42 * interface.
43 */
44 /** @namespace __gnu_internal
45 * @brief GNU implemenation details, not for public use or
46 * export. Used only when anonymous namespaces cannot be substituted.
47 */
48 // // // // // // // // // // // // // // // // // // // // // // // //
49
50 /**
51 * @defgroup extensions Extensions
52 *
53 * Components generally useful that are not part of any standard.
54 */
55
56 /** @defgroup SGIextensions SGI
57 * @ingroup extensions
58 Because libstdc++ based its implementation of the STL subsections of
59 the library on the SGI 3.3 implementation, we inherited their extensions
60 as well.
61
62 They are additionally documented in the
63 <a href="http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html">
64 online documentation</a>, a copy of which is also shipped with the
65 library source code (in .../docs/html/documentation.html). You can also
66 read the documentation <a href="http://www.sgi.com/tech/stl/">on SGI's
67 site</a>, which is still running even though the code is not maintained.
68
69 <strong>NB</strong> that the following notes are pulled from various
70 comments all over the place, so they may seem stilted.
71 <hr>
72 */
73
74 /** @defgroup containers Containers
75 Containers are collections of objects.
76
77 A container may hold any type which meets certain requirements, but the type
78 of contained object is chosen at compile time, and all objects in a given
79 container must be of the same type. (Polymorphism is possible by declaring a
80 container of pointers to a base class and then populating it with pointers to
81 instances of derived classes. Variant value types such as the @c any class
82 from <a href="http://www.boost.org/">Boost</a> can also be used.
83
84 All contained types must be @c Assignable and @c CopyConstructible.
85 Specific containers may place additional requirements on the types of
86 their contained objects.
87
88 Containers manage memory allocation and deallocation themselves when
89 storing your objects. The objects are destroyed when the container is
90 itself destroyed. Note that if you are storing pointers in a container,
91 @c delete is @e not automatically called on the pointers before destroying them.
92
93 All containers must meet certain requirements, summarized in
94 <a href="tables.html">tables</a>.
95
96 The standard containers are further refined into
97 @link sequences Sequences@endlink and
98 @link associative_containers Associative Containers@endlink.
99 @link unordered_associative_containers Unordered Associative Containers@endlink.
100 */
101
102 /** @defgroup sequences Sequences
103 * @ingroup containers
104 Sequences arrange a collection of objects into a strictly linear order.
105
106 The differences between sequences are usually due to one or both of the
107 following:
108 - memory management
109 - algorithmic complexity
110
111 As an example of the first case, @c vector is required to use a contiguous
112 memory layout, while other sequences such as @c deque are not.
113
114 The prime reason for choosing one sequence over another should be based on
115 the second category of differences, algorithmic complexity. For example, if
116 you need to perform many inserts and removals from the middle of a sequence,
117 @c list would be ideal. But if you need to perform constant-time access to
118 random elements of the sequence, then @c list should not be used.
119
120 All sequences must meet certain requirements, summarized in
121 <a href="tables.html">tables</a>.
122 */
123
124 /** @defgroup associative_containers Associative
125 * @ingroup containers
126 Associative containers allow fast retrieval of data based on keys.
127
128 Each container type is parameterized on a @c Key type, and an ordering
129 relation used to sort the elements of the container.
130
131 All associative containers must meet certain requirements, summarized in
132 <a href="tables.html">tables</a>.
133 */
134
135 /** @defgroup unordered_associative_containers Unordered Associative
136 * @ingroup containers
137 Unordered associative containers allow fast retrieval of data based on keys.
138
139 Each container type is parameterized on a @c Key type, a @c Hash type
140 providing a hashing functor, and an ordering relation used to sort the
141 elements of the container.
142
143 All unordered associative containers must meet certain requirements,
144 summarized in <a href="tables.html">tables</a>. */
145
146 /**
147 * @defgroup diagnostics Diagnostics
148 *
149 * Components for error handling, reporting, and diagnostic operations.
150 */
151
152 /**
153 * @defgroup concurrency Concurrency
154 *
155 * Components for concurrent operations, including threads, mutexes,
156 * and condition variables.
157 */