summaryrefslogtreecommitdiff
path: root/libstdc++-v3/docs/doxygen/doxygroups.cc
diff options
context:
space:
mode:
authorbkoz <bkoz@138bc75d-0d04-0410-961f-82ee72b054a4>2008-01-18 08:16:51 +0000
committerbkoz <bkoz@138bc75d-0d04-0410-961f-82ee72b054a4>2008-01-18 08:16:51 +0000
commit0aeadebf36eab6d537b67b38c5dcacf648f2f69f (patch)
tree0fd3dc60ac26e2ec9502783b72d38867bcb418d8 /libstdc++-v3/docs/doxygen/doxygroups.cc
parent9e61be0719e3f9d3bda483eaaf71ee67f02e81ae (diff)
downloadgcc-0aeadebf36eab6d537b67b38c5dcacf648f2f69f.tar.gz
2008-01-18 Benjamin Kosnik <bkoz@redhat.com>
* docs/*: To... * doc/*: ...here. * testsuite/Makefile.am: Move doc-performance to... * Makefile.am: Add doc to SUBDIRS, move doxygen-* rules to... * doc/Makefile.am: Consolidate documentation creation here. (doc-doxygen-html): New. (doc-doxygen-man): New. (doc-performance): New. * doc/Makefile.in: New. * acinclude.m4 (glibcxx_SUBDIRS): Add doc directory. * doc/doxygen/guide.html: Edit for unified html configuration. * doc/doxygen/mainpage.html: Same. * doc/doxygen/run_doxygen: Same, more namespace fixups for man generation. * doc/doxygen/user.cfg.in: Update for doxygen 1.5.4. * include/tr1_impl/random: Remove maint from doxygen markup. * include/tr1_impl/functional: Same. * include/std/tuple: Same. * include/std/streambuf: Same. * include/std/bitset: Same. * include/std/limits: Same. * include/std/fstream: Same. * include/std/istream: Same. * include/std/sstream: Same. * include/ext/pool_allocator.h: Same. * include/ext/rc_string_base.h: Same. * include/bits/basic_ios.h: Same. * include/bits/stl_list.h: Same. * include/bits/stl_map.h: Same. * include/bits/locale_classes.h: Same. * include/bits/stl_set.h: Same. * include/bits/stl_iterator_base_types.h: Same. * include/bits/basic_string.h: Same. * include/bits/stl_multimap.h: Same. * include/bits/stl_vector.h: Same. * include/bits/ios_base.h: Same. * include/bits/stl_deque.h: Same. * include/bits/postypes.h: Same. * include/bits/stl_multiset.h: Same. * include/bits/stl_algo.h: Same. * include/bits/stl_iterator.h: Same. * include/bits/stl_tempbuf.h: Same. * include/bits/stl_construct.h: Same. * include/bits/stl_relops.h: Same. * include/tr1/tuple: Same. * include/backward/auto_ptr.h: Same. * testsuite/23_containers/vector/requirements/dr438/assign_neg.cc: Fixups for line number changes. * testsuite/23_containers/vector/requirements/dr438/insert_neg.cc: Same. * testsuite/23_containers/vector/requirements/dr438/ constructor_1_neg.cc: Same. * testsuite/23_containers/vector/requirements/dr438/ constructor_2_neg.cc: Same. * testsuite/23_containers/deque/requirements/dr438/assign_neg.cc: Same. * testsuite/23_containers/deque/requirements/dr438/insert_neg.cc: Same. * testsuite/23_containers/deque/requirements/dr438/ constructor_1_neg.cc: Same. * testsuite/23_containers/deque/requirements/dr438/ constructor_2_neg.cc: Same. * testsuite/23_containers/list/requirements/dr438/assign_neg.cc: Same. * testsuite/23_containers/list/requirements/dr438/insert_neg.cc: Same. * testsuite/23_containers/list/requirements/dr438/ constructor_1_neg.cc: Same. * testsuite/23_containers/list/requirements/dr438/ constructor_2_neg.cc: Same. * testsuite/20_util/auto_ptr/assign_neg.cc: Same. * aclocal.m4: Regenerate. * config.h.in: Regenerate. * configure: Regenerate. * Makefile.in: Regenerate. * src/Makefile.in: Regenerate. * po/Makefile.in: Regenerate. * libmath/Makefile.in: Regenerate. * include/Makefile.in: Regenerate. * libsupc++/Makefile.in: Regenerate. * testsuite/Makefile.in: Regenerate. * scripts/make_graphs.py: Correct paths for new layout. 2008-01-17 Benjamin Kosnik <bkoz@redhat.com> * acinclude.m4 (AC_LC_MESSAGES): Remove serial. * linkage.m4 (AC_REPLACE_MATHFUNCS): Same. * configure: Regenerate. * aclocal.m4: Regenerate. git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@131625 138bc75d-0d04-0410-961f-82ee72b054a4
Diffstat (limited to 'libstdc++-v3/docs/doxygen/doxygroups.cc')
-rw-r--r--libstdc++-v3/docs/doxygen/doxygroups.cc238
1 files changed, 0 insertions, 238 deletions
diff --git a/libstdc++-v3/docs/doxygen/doxygroups.cc b/libstdc++-v3/docs/doxygen/doxygroups.cc
deleted file mode 100644
index 68d142fdbfb..00000000000
--- a/libstdc++-v3/docs/doxygen/doxygroups.cc
+++ /dev/null
@@ -1,238 +0,0 @@
-/*
- Copyright (C) 2001, 2002, 2005 Free Software Foundation, Inc.
- See license.html for license.
-
- This just provides documentation for stuff that doesn't need to be in the
- source headers themselves. It is a ".cc" file for the sole cheesy reason
- that it triggers many different text editors into doing Nice Things when
- typing comments. However, it is mentioned nowhere except the *cfg.in files.
-
- Some actual code (declarations) is exposed here, but no compiler ever
- sees it. The decls must be visible to doxygen, and sometimes their real
- declarations are not visible, or not visible in a way we want.
-
- Pieces separated by '// //' lines will usually not be presented to the
- user on the same page.
-*/
-
-// // // // // // // // // // // // // // // // // // // // // // // //
-/** @namespace std
- * @brief Everything defined by the ISO C++ Standard is within
- * namespace <a class="el" href="namespacestd.html">std</a>.
-*/
-/** @namespace std::__detail
- * @brief Implementation details not part of the namespace <a class="el"
- * href="namespacestd.html">std</a> interface.
-*/
-/** @namespace std::tr1
- * @brief Everything defined by the ISO C++ TR1 is within namespace std::tr1.
-*/
-/** @namespace std::tr1::__detail
- * @brief Implementation details not part of the namespace std::tr1 interface.
-*/
-/** @namespace __gnu_cxx
- * @brief GNU extensions for public use.
-*/
-/** @namespace __gnu_cxx::__detail
- * @brief Implementation details not part of the namespace __gnu_cxx
- * interface.
-*/
-/** @namespace __gnu_cxx::typelist
- * @brief GNU typelist extensions for public compile-time use.
-*/
-/** @namespace __gnu_internal
- * @brief GNU implemenation details, not for public use or
- * export. Used only when anonymous namespaces cannot be substituted.
-*/
-/** @namespace __gnu_debug
- * @brief GNU debug classes for public use.
-*/
-// // // // // // // // // // // // // // // // // // // // // // // //
-/** @addtogroup SGIextensions STL extensions from SGI
-Because libstdc++ based its implementation of the STL subsections of
-the library on the SGI 3.3 implementation, we inherited their extensions
-as well.
-
-They are additionally documented in the
-<a href="http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html">
-online documentation</a>, a copy of which is also shipped with the
-library source code (in .../docs/html/documentation.html). You can also
-read the documentation <a href="http://www.sgi.com/tech/stl/">on SGI's
-site</a>, which is still running even though the code is not maintained.
-
-<strong>NB</strong> that the following notes are pulled from various
-comments all over the place, so they may seem stilted.
-<hr>
-*/
-
-// // // // // // // // // // // // // // // // // // // // // // // //
-// This is standalone because, unlike the functor introduction, there is no
-// single header file which serves as a base "all containers must include
-// this header". We do some quoting of 14882 here.
-/** @addtogroup Containers Containers
-Containers are collections of objects.
-
-A container may hold any type which meets certain requirements, but the type
-of contained object is chosen at compile time, and all objects in a given
-container must be of the same type. (Polymorphism is possible by declaring a
-container of pointers to a base class and then populating it with pointers to
-instances of derived classes. Variant value types such as the @c any class
-from <a href="http://www.boost.org/">Boost</a> can also be used.
-
-All contained types must be @c Assignable and @c CopyConstructible.
-Specific containers may place additional requirements on the types of
-their contained objects.
-
-Containers manage memory allocation and deallocation themselves when
-storing your objects. The objects are destroyed when the container is
-itself destroyed. Note that if you are storing pointers in a container,
-@c delete is @e not automatically called on the pointers before destroying them.
-
-All containers must meet certain requirements, summarized in
-<a href="tables.html">tables</a>.
-
-The standard containers are further refined into
-@link Sequences Sequences@endlink and
-@link Assoc_containers Associative Containers@endlink.
-*/
-
-/** @addtogroup Sequences Sequences
-Sequences arrange a collection of objects into a strictly linear order.
-
-The differences between sequences are usually due to one or both of the
-following:
- - memory management
- - algorithmic complexity
-
-As an example of the first case, @c vector is required to use a contiguous
-memory layout, while other sequences such as @c deque are not.
-
-The prime reason for choosing one sequence over another should be based on
-the second category of differences, algorithmic complexity. For example, if
-you need to perform many inserts and removals from the middle of a sequence,
-@c list would be ideal. But if you need to perform constant-time access to
-random elements of the sequence, then @c list should not be used.
-
-All sequences must meet certain requirements, summarized in
-<a href="tables.html">tables</a>.
-*/
-
-/** @addtogroup Assoc_containers Associative Containers
-Associative containers allow fast retrieval of data based on keys.
-
-Each container type is parameterized on a @c Key type, and an ordering
-relation used to sort the elements of the container.
-
-There should be more text here.
-
-All associative containers must meet certain requirements, summarized in
-<a href="tables.html">tables</a>.
-*/
-
-// // // // // // // // // // // // // // // // // // // // // // // //
-/** @namespace abi
- * @brief The cross-vendor C++ Application Binary Interface. A
- * namespace alias to __cxxabiv1.
- *
- * A brief overview of an ABI is given in the libstdc++ FAQ, question
- * 5.8 (you may have a copy of the FAQ locally, or you can view the online
- * version at http://gcc.gnu.org/onlinedocs/libstdc++/faq/index.html#5_8).
- *
- * GCC subscribes to a relatively-new cross-vendor ABI for C++, sometimes
- * called the IA64 ABI because it happens to be the native ABI for that
- * platform. It is summarized at http://www.codesourcery.com/cxx-abi/
- * along with the current specification.
- *
- * For users of GCC greater than or equal to 3.x, entry points are
- * available in <cxxabi.h>, which notes, <em>"It is not normally
- * necessary for user programs to include this header, or use the
- * entry points directly. However, this header is available should
- * that be needed."</em>
-*/
-
-namespace abi {
-/**
-@brief New ABI-mandated entry point in the C++ runtime library for demangling.
-
-@param mangled_name A NUL-terminated character string containing the name
- to be demangled.
-
-@param output_buffer A region of memory, allocated with malloc, of
- @a *length bytes, into which the demangled name
- is stored. If @a output_buffer is not long enough,
- it is expanded using realloc. @a output_buffer may
- instead be NULL; in that case, the demangled name is
- placed in a region of memory allocated with malloc.
-
-@param length If @a length is non-NULL, the length of the buffer containing
- the demangled name is placed in @a *length.
-
-@param status @a *status is set to one of the following values:
- - 0: The demangling operation succeeded.
- - -1: A memory allocation failiure occurred.
- - -2: @a mangled_name is not a valid name under the C++ ABI
- mangling rules.
- - -3: One of the arguments is invalid.
-
-@return A pointer to the start of the NUL-terminated demangled name, or NULL
- if the demangling fails. The caller is responsible for deallocating
- this memory using @c free.
-
-
-The demangling is performed using the C++ ABI mangling rules, with
-GNU extensions. For example, this function is used
-in __gnu_cxx::__verbose_terminate_handler. See
-http://gcc.gnu.org/onlinedocs/libstdc++/18_support/howto.html#5 for other
-examples of use.
-
-@note The same demangling functionality is available via libiberty
-(@c <libiberty/demangle.h> and @c libiberty.a) in GCC 3.1 and later, but that
-requires explicit installation (@c --enable-install-libiberty) and uses a
-different API, although the ABI is unchanged.
-*/
-char* __cxa_demangle (const char* mangled_name, char* output_buffer,
- size_t* length, int* status);
-} // namespace abi
-
-// // // // // // // // // // // // // // // // // // // // // // // //
-/** @addtogroup binarysearch Binary search algorithms
-These algorithms are variations of a classic binary search. They all assume
-that the sequence being searched is already sorted.
-
-The number of comparisons will be logarithmic (and as few as possible).
-The number of steps through the sequence will be logarithmic for
-random-access iterators (e.g., pointers), and linear otherwise.
-
-The LWG has passed Defect Report 270, which notes: <em>The proposed
-resolution reinterprets binary search. Instead of thinking about searching
-for a value in a sorted range, we view that as an important special
-case of a more general algorithm: searching for the partition point in a
-partitioned range. We also add a guarantee that the old wording did not:
-we ensure that the upper bound is no earlier than the lower bound, that
-the pair returned by equal_range is a valid range, and that the first part
-of that pair is the lower bound.</em>
-
-The actual effect of the first sentence is that a comparison functor
-passed by the user doesn't necessarily need to induce a strict weak ordering
-relation. Rather, it partitions the range.
-*/
-
-// // // // // // // // // // // // // // // // // // // // // // // //
-/** @addtogroup setoperations Set operation algorithms
-These algorithms are common set operations performed on sequences that are
-already sorted.
-
-The number of comparisons will be linear.
-*/
-
-// // // // // // // // // // // // // // // // // // // // // // // //
-
-// // // // // // // // // // // // // // // // // // // // // // // //
-/* * @addtogroup groupname description of group
-placeholder text
-*/
-
-// // // // // // // // // // // // // // // // // // // // // // // //
-
-// vim:et:noai:
-