diff options
Diffstat (limited to 'libstdc++-v3/doc/doxygen')
| -rw-r--r-- | libstdc++-v3/doc/doxygen/doxygroups.cc | 110 | ||||
| -rw-r--r-- | libstdc++-v3/doc/doxygen/user.cfg.in | 20 |
2 files changed, 33 insertions, 97 deletions
diff --git a/libstdc++-v3/doc/doxygen/doxygroups.cc b/libstdc++-v3/doc/doxygen/doxygroups.cc index cdca01e..d11fb3b 100644 --- a/libstdc++-v3/doc/doxygen/doxygroups.cc +++ b/libstdc++-v3/doc/doxygen/doxygroups.cc @@ -28,18 +28,6 @@ /** @namespace std::tr1::__detail * @brief Implementation details not part of the namespace std::tr1 interface. */ -/** @namespace std::chrono - * @brief ISO C++ 0x entities sub namespace for time and date. -*/ -/** @namespace std::placeholders - * @brief ISO C++ 0x entities sub namespace for functional. -*/ -/** @namespace std::regex_constants - * @brief ISO C++ 0x entities sub namespace for regex. -*/ -/** @namespace std::this_thread - * @brief ISO C++ 0x entities sub namespace for thread. -*/ /** @namespace __gnu_cxx * @brief GNU extensions for public use. */ @@ -52,71 +40,6 @@ * export. Used only when anonymous namespaces cannot be substituted. */ // // // // // // // // // // // // // // // // // // // // // // // // -/** @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 - -// // // // // // // // // // // // // // // // // // // // // // // // /** * @defgroup extensions Extensions @@ -142,10 +65,6 @@ 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. /** @defgroup containers Containers Containers are collections of objects. @@ -169,9 +88,9 @@ 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. -@link Unordered_assoc_containers Unordered Associative Containers@endlink. +@link sequences Sequences@endlink and +@link associative_containers Associative Containers@endlink. +@link unordered_associative_containers Unordered Associative Containers@endlink. */ /** @defgroup sequences Sequences @@ -218,9 +137,22 @@ elements of the container. All unordered associative containers must meet certain requirements, summarized in <a href="tables.html">tables</a>. */ -// // // // // // // // // // // // // // // // // // // // // // // // -/* * @defgroup groupname description of group -placeholder text -*/ +/** + * @defgroup diagnostics Diagnostics + * + * Components for error handling, reporting, and diagnostic operations. + */ -// // // // // // // // // // // // // // // // // // // // // // // // +/** + * @defgroup concurrency Concurrency + * + * Components for concurrent operations, including threads, mutexes, + * and condition variables. + */ + +/** + * @defgroup pointer_abstractions Pointer Abstractions + * @ingroup memory + * + * Components for memory allocation, deallocation, and management. + */ diff --git a/libstdc++-v3/doc/doxygen/user.cfg.in b/libstdc++-v3/doc/doxygen/user.cfg.in index 086f499..aceb670 100644 --- a/libstdc++-v3/doc/doxygen/user.cfg.in +++ b/libstdc++-v3/doc/doxygen/user.cfg.in @@ -416,7 +416,7 @@ SORT_BRIEF_DOCS = YES # hierarchy of group names into alphabetical order. If set to NO (the default) # the group names will appear in their defined order. -SORT_GROUP_NAMES = NO +SORT_GROUP_NAMES = YES # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # sorted by fully-qualified names, including namespaces. If set to @@ -539,7 +539,7 @@ WARN_IF_UNDOCUMENTED = NO # parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. -WARN_IF_DOC_ERROR = NO +WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be abled to get warnings for # functions that are documented, but have no documentation for their parameters @@ -573,9 +573,11 @@ WARN_LOGFILE = # "myfile.cpp" or directories like "/usr/src/myproject". Separate the # files or directories with spaces. -INPUT = @srcdir@/libsupc++/cxxabi.h \ +INPUT = @srcdir@/doc/doxygen/doxygroups.cc \ + @srcdir@/libsupc++/cxxabi.h \ @srcdir@/libsupc++/cxxabi-forced.h \ @srcdir@/libsupc++/exception \ + @srcdir@/libsupc++/exception_ptr.h \ @srcdir@/libsupc++/initializer_list \ @srcdir@/libsupc++/new \ @srcdir@/libsupc++/typeinfo \ @@ -713,18 +715,18 @@ INPUT = @srcdir@/libsupc++/cxxabi.h \ include/tr1_impl/unordered_map \ include/tr1_impl/unordered_set \ include/tr1_impl/utility \ + include/tr1_impl \ + include/tr1 \ include/ \ include/@host_alias@/bits \ include/backward \ include/bits \ + include/bits/shared_ptr.h \ include/debug \ include/parallel \ - include/tr1 \ - include/tr1_impl \ include/ext \ include/ext/pb_ds \ - include/ext/pb_ds/detail \ - @srcdir@/doc/doxygen/doxygroups.cc + include/ext/pb_ds/detail # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is @@ -1419,6 +1421,7 @@ PREDEFINED = __cplusplus \ __GTHREADS \ _GLIBCXX_HAS_GTHREADS \ __GXX_EXPERIMENTAL_CXX0X__ \ + _GLIBCXX_INCLUDE_AS_CXX0X \ "_GLIBCXX_STD_P= " \ "_GLIBCXX_STD_D= " \ _GLIBCXX_STD=std \ @@ -1430,11 +1433,12 @@ PREDEFINED = __cplusplus \ _GLIBCXX_END_NAMESPACE=} \ _GLIBCXX_END_NESTED_NAMESPACE=} \ "_GLIBCXX_TEMPLATE_ARGS=... " \ - _GLIBCXX_INCLUDE_AS_CXX0X \ _GLIBCXX_DEPRECATED \ _GLIBCXX_USE_WCHAR_T \ _GLIBCXX_USE_LONG_LONG \ _GLIBCXX_USE_C99_STDINT_TR1 \ + _GLIBCXX_USE_SCHED_YIELD \ + _GLIBCXX_USE_NANOSLEEP \ __glibcxx_function_requires=// \ __glibcxx_class_requires=// \ __glibcxx_class_requires2=// \ |