doxygroups.cc

00001 /*
00002    Copyright (C) 2001, 2002, 2005, 2008, 2009 Free Software Foundation, Inc.
00003    See license.html for license.
00004 
00005    This just provides documentation for stuff that doesn't need to be in the
00006    source headers themselves.  It is a ".cc" file for the sole cheesy reason
00007    that it triggers many different text editors into doing Nice Things when
00008    typing comments.  However, it is mentioned nowhere except the *cfg.in files.
00009 
00010    Some actual code (declarations) is exposed here, but no compiler ever
00011    sees it.  The decls must be visible to doxygen, and sometimes their real
00012    declarations are not visible, or not visible in a way we want.
00013 
00014    Pieces separated by '// //' lines will usually not be presented to the
00015    user on the same page.
00016 */
00017 
00018 // // // // // // // // // // // // // // // // // // // // // // // //
00019 /** @namespace std
00020  *  @brief ISO C++ entities toplevel namespace is std.
00021 */
00022 /** @namespace std::__detail
00023  *  @brief Implementation details not part of the namespace std interface.
00024 */
00025 /** @namespace std::tr1
00026  *  @brief ISO C++ TR1 entities toplevel namespace is std::tr1.
00027 */
00028 /** @namespace std::tr1::__detail
00029  *  @brief Implementation details not part of the namespace std::tr1 interface.
00030 */
00031 /** @namespace __gnu_cxx
00032  *  @brief GNU extensions for public use.
00033 */
00034 /** @namespace __gnu_cxx::__detail
00035  *  @brief Implementation details not part of the namespace __gnu_cxx 
00036  *  interface.
00037 */
00038 /** @namespace __gnu_internal
00039  *  @brief GNU implemenation details, not for public use or
00040  *  export. Used only when anonymous namespaces cannot be substituted.
00041 */
00042 // // // // // // // // // // // // // // // // // // // // // // // //
00043 
00044 /**
00045  * @defgroup extensions Extensions
00046  *
00047  * Components generally useful that are not part of any standard.
00048  */
00049 
00050 /** @defgroup SGIextensions SGI STL extensions
00051  * @ingroup extensions
00052 Because libstdc++ based its implementation of the STL subsections of
00053 the library on the SGI 3.3 implementation, we inherited their extensions
00054 as well.
00055 
00056 They are additionally documented in the
00057 <a href="http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html">
00058 online documentation</a>, a copy of which is also shipped with the
00059 library source code (in .../docs/html/documentation.html).  You can also
00060 read the documentation <a href="http://www.sgi.com/tech/stl/">on SGI's
00061 site</a>, which is still running even though the code is not maintained.
00062 
00063 <strong>NB</strong> that the following notes are pulled from various
00064 comments all over the place, so they may seem stilted.
00065 <hr>
00066 */
00067 
00068 /** @defgroup containers Containers
00069 Containers are collections of objects.
00070 
00071 A container may hold any type which meets certain requirements, but the type
00072 of contained object is chosen at compile time, and all objects in a given
00073 container must be of the same type.  (Polymorphism is possible by declaring a
00074 container of pointers to a base class and then populating it with pointers to
00075 instances of derived classes.  Variant value types such as the @c any class
00076 from <a href="http://www.boost.org/">Boost</a> can also be used.
00077 
00078 All contained types must be @c Assignable and @c CopyConstructible.
00079 Specific containers may place additional requirements on the types of
00080 their contained objects.
00081 
00082 Containers manage memory allocation and deallocation themselves when
00083 storing your objects.  The objects are destroyed when the container is
00084 itself destroyed.  Note that if you are storing pointers in a container,
00085 @c delete is @e not automatically called on the pointers before destroying them.
00086 
00087 All containers must meet certain requirements, summarized in
00088 <a href="tables.html">tables</a>.
00089 
00090 The standard containers are further refined into
00091 @link sequences Sequences@endlink and
00092 @link associative_containers Associative Containers@endlink.
00093 @link unordered_associative_containers Unordered Associative Containers@endlink.
00094 */
00095 
00096 /** @defgroup sequences Sequences
00097  * @ingroup containers
00098 Sequences arrange a collection of objects into a strictly linear order.
00099 
00100 The differences between sequences are usually due to one or both of the
00101 following:
00102   - memory management
00103   - algorithmic complexity
00104 
00105 As an example of the first case, @c vector is required to use a contiguous
00106 memory layout, while other sequences such as @c deque are not.
00107 
00108 The prime reason for choosing one sequence over another should be based on
00109 the second category of differences, algorithmic complexity.  For example, if
00110 you need to perform many inserts and removals from the middle of a sequence,
00111 @c list would be ideal.  But if you need to perform constant-time access to
00112 random elements of the sequence, then @c list should not be used.
00113 
00114 All sequences must meet certain requirements, summarized in
00115 <a href="tables.html">tables</a>.
00116 */
00117 
00118 /** @defgroup associative_containers Associative Containers
00119  * @ingroup containers
00120 Associative containers allow fast retrieval of data based on keys.
00121 
00122 Each container type is parameterized on a @c Key type, and an ordering
00123 relation used to sort the elements of the container.
00124 
00125 All associative containers must meet certain requirements, summarized in
00126 <a href="tables.html">tables</a>.
00127 */
00128 
00129 /** @defgroup unordered_associative_containers Unordered Associative Containers
00130  * @ingroup containers
00131 Unordered associative containers allow fast retrieval of data based on keys.
00132 
00133 Each container type is parameterized on a @c Key type, a @c Hash type
00134 providing a hashing functor, and an ordering relation used to sort the
00135 elements of the container.
00136 
00137 All unordered associative containers must meet certain requirements,
00138 summarized in <a href="tables.html">tables</a>.  */
00139 
00140 /**
00141  * @defgroup diagnostics Diagnostics
00142  *
00143  * Components for error handling, reporting, and diagnostic operations.
00144  */
00145 
00146 /**
00147  * @defgroup concurrency Concurrency
00148  *
00149  * Components for concurrent operations, including threads, mutexes,
00150  * and condition variables.
00151  */
00152 
00153 /**
00154  * @defgroup pointer_abstractions Pointer Abstractions
00155  * @ingroup memory
00156  *
00157  * Components for memory allocation, deallocation, and management.
00158  */

Generated on Thu Jul 23 21:16:04 2009 for libstdc++ by  doxygen 1.5.8