libstdc++-v3/doc/doxygen/doxygroups.cc

   1 /*
   2    Copyright (C) 2001, 2002, 2005, 2008, 2009 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 __gnu_cxx
  32  *  @brief GNU extensions for public use.
  33 */
  34 /** @namespace __gnu_cxx::__detail
  35  *  @brief Implementation details not part of the namespace __gnu_cxx
  36  *  interface.
  37 */
  38 /** @namespace __gnu_internal
  39  *  @brief GNU implemenation details, not for public use or
  40  *  export. Used only when anonymous namespaces cannot be substituted.
  41 */
  42 // // // // // // // // // // // // // // // // // // // // // // // //
  43
  44 /**
  45  * @defgroup extensions Extensions
  46  *
  47  * Components generally useful that are not part of any standard.
  48  */
  49
  50 /** @defgroup SGIextensions SGI STL extensions
  51  * @ingroup extensions
  52 Because libstdc++ based its implementation of the STL subsections of
  53 the library on the SGI 3.3 implementation, we inherited their extensions
  54 as well.
  55
  56 They are additionally documented in the
  57 <a href="http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html">
  58 online documentation</a>, a copy of which is also shipped with the
  59 library source code (in .../docs/html/documentation.html).  You can also
  60 read the documentation <a href="http://www.sgi.com/tech/stl/">on SGI's
  61 site</a>, which is still running even though the code is not maintained.
  62
  63 <strong>NB</strong> that the following notes are pulled from various
  64 comments all over the place, so they may seem stilted.
  65 <hr>
  66 */
  67
  68 /** @defgroup containers Containers
  69 Containers are collections of objects.
  70
  71 A container may hold any type which meets certain requirements, but the type
  72 of contained object is chosen at compile time, and all objects in a given
  73 container must be of the same type.  (Polymorphism is possible by declaring a
  74 container of pointers to a base class and then populating it with pointers to
  75 instances of derived classes.  Variant value types such as the @c any class
  76 from <a href="http://www.boost.org/">Boost</a> can also be used.
  77
  78 All contained types must be @c Assignable and @c CopyConstructible.
  79 Specific containers may place additional requirements on the types of
  80 their contained objects.
  81
  82 Containers manage memory allocation and deallocation themselves when
  83 storing your objects.  The objects are destroyed when the container is
  84 itself destroyed.  Note that if you are storing pointers in a container,
  85 @c delete is @e not automatically called on the pointers before destroying them.
  86
  87 All containers must meet certain requirements, summarized in
  88 <a href="tables.html">tables</a>.
  89
  90 The standard containers are further refined into
  91 @link sequences Sequences@endlink and
  92 @link associative_containers Associative Containers@endlink.
  93 @link unordered_associative_containers Unordered Associative Containers@endlink.
  94 */
  95
  96 /** @defgroup sequences Sequences
  97  * @ingroup containers
  98 Sequences arrange a collection of objects into a strictly linear order.
  99
 100 The differences between sequences are usually due to one or both of the
 101 following:
 102   - memory management
 103   - algorithmic complexity
 104
 105 As an example of the first case, @c vector is required to use a contiguous
 106 memory layout, while other sequences such as @c deque are not.
 107
 108 The prime reason for choosing one sequence over another should be based on
 109 the second category of differences, algorithmic complexity.  For example, if
 110 you need to perform many inserts and removals from the middle of a sequence,
 111 @c list would be ideal.  But if you need to perform constant-time access to
 112 random elements of the sequence, then @c list should not be used.
 113
 114 All sequences must meet certain requirements, summarized in
 115 <a href="tables.html">tables</a>.
 116 */
 117
 118 /** @defgroup associative_containers Associative Containers
 119  * @ingroup containers
 120 Associative containers allow fast retrieval of data based on keys.
 121
 122 Each container type is parameterized on a @c Key type, and an ordering
 123 relation used to sort the elements of the container.
 124
 125 All associative containers must meet certain requirements, summarized in
 126 <a href="tables.html">tables</a>.
 127 */
 128
 129 /** @defgroup unordered_associative_containers Unordered Associative Containers
 130  * @ingroup containers
 131 Unordered associative containers allow fast retrieval of data based on keys.
 132
 133 Each container type is parameterized on a @c Key type, a @c Hash type
 134 providing a hashing functor, and an ordering relation used to sort the
 135 elements of the container.
 136
 137 All unordered associative containers must meet certain requirements,
 138 summarized in <a href="tables.html">tables</a>.  */
 139
 140 /**
 141  * @defgroup diagnostics Diagnostics
 142  *
 143  * Components for error handling, reporting, and diagnostic operations.
 144  */
 145
 146 /**
 147  * @defgroup concurrency Concurrency
 148  *
 149  * Components for concurrent operations, including threads, mutexes,
 150  * and condition variables.
 151  */