ea32f15d44
This attempts to improve the doxygen output to work around what seems to
be some bugs in doxygen (issues 8635 and 8638).
The @addtogroup command doesn't work for entities inside a nested
namespace (see 8635) so we need to close and reopen groups on entering
and elaving nested namespaces. This fixes the problem that
chrono::duration and chrono::time_point were not documented in the
"Time" documentation group. I am unable to make the path classes appear
as part of their relevant groups (File System and Filesystem TS), nor
the contents of <exception> or <system_error>. I have made some minor
improvements to the docs for those types, including starting to address
PR 97001 by adding @since to the doxygen comments.
This change also excludes the <experimental/bits/net.h> header from
Doxygen processing, so we don't get an unwanted "Networking-ts" group
in the documentation.
Signed-off-by: Jonathan Wakely <jwakely@redhat.com>
libstdc++-v3/ChangeLog:
* doc/doxygen/doxygroups.cc: Fix docs for std::literals.
* doc/doxygen/user.cfg.in: Exclude the Networking TS header.
Add some more predefined macros.
* include/bits/fs_fwd.h: Move @addtogroup commands inside
namespaces. Add better documentation.
* include/bits/fs_path.h: Likewise.
* include/experimental/bits/fs_fwd.h: Likewise.
* include/experimental/bits/fs_path.h: Likewise.
* include/ext/throw_allocator.h: Fix typo and improve docs.
* include/std/chrono: Move @addtogroup commands.
* include/std/system_error: Move @addtogroup commands.
* libsupc++/exception: Improve documentation.
* libsupc++/exception.h: Add @since documentation.
(cherry picked from commit f2ce64b53f)
88 lines
2.4 KiB
C++
88 lines
2.4 KiB
C++
// Exception Handling support header for -*- C++ -*-
|
|
|
|
// Copyright (C) 2016-2021 Free Software Foundation, Inc.
|
|
//
|
|
// This file is part of GCC.
|
|
//
|
|
// GCC is free software; you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation; either version 3, or (at your option)
|
|
// any later version.
|
|
//
|
|
// GCC is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// Under Section 7 of GPL version 3, you are granted additional
|
|
// permissions described in the GCC Runtime Library Exception, version
|
|
// 3.1, as published by the Free Software Foundation.
|
|
|
|
// You should have received a copy of the GNU General Public License and
|
|
// a copy of the GCC Runtime Library Exception along with this program;
|
|
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
|
|
// <http://www.gnu.org/licenses/>.
|
|
|
|
/** @file bits/exception.h
|
|
* This is an internal header file, included by other library headers.
|
|
* Do not attempt to use it directly.
|
|
*/
|
|
|
|
#ifndef __EXCEPTION_H
|
|
#define __EXCEPTION_H 1
|
|
|
|
#pragma GCC system_header
|
|
|
|
#pragma GCC visibility push(default)
|
|
|
|
#include <bits/c++config.h>
|
|
|
|
extern "C++" {
|
|
|
|
namespace std
|
|
{
|
|
/**
|
|
* @defgroup exceptions Exceptions
|
|
* @ingroup diagnostics
|
|
* @since C++98
|
|
*
|
|
* Classes and functions for reporting errors via exceptions.
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Base class for all library exceptions.
|
|
*
|
|
* This is the base class for all exceptions thrown by the standard
|
|
* library, and by certain language expressions. You are free to derive
|
|
* your own %exception classes, or use a different hierarchy, or to
|
|
* throw non-class data (e.g., fundamental types).
|
|
*/
|
|
class exception
|
|
{
|
|
public:
|
|
exception() _GLIBCXX_NOTHROW { }
|
|
virtual ~exception() _GLIBCXX_TXN_SAFE_DYN _GLIBCXX_NOTHROW;
|
|
#if __cplusplus >= 201103L
|
|
exception(const exception&) = default;
|
|
exception& operator=(const exception&) = default;
|
|
exception(exception&&) = default;
|
|
exception& operator=(exception&&) = default;
|
|
#endif
|
|
|
|
/** Returns a C-style character string describing the general cause
|
|
* of the current error. */
|
|
virtual const char*
|
|
what() const _GLIBCXX_TXN_SAFE_DYN _GLIBCXX_NOTHROW;
|
|
};
|
|
|
|
/// @}
|
|
|
|
} // namespace std
|
|
|
|
}
|
|
|
|
#pragma GCC visibility pop
|
|
|
|
#endif
|