Commit f910786b by Benjamin Kosnik Committed by Benjamin Kosnik

*: Use headername alias to associate private includes to public includes.

2010-11-18  Benjamin Kosnik  <bkoz@redhat.com>

	* config/*/*: Use headername alias to associate private includes
	to public includes.
	* include/*/*: Same.

	* scripts/run_doxygen: Update for doxygen 1.7.2.
	* doc/doxygen/user.cfg.in: Same.
	* doc/doxygen/TODO: Remove.

	* testsuite/*/std_c++0x_neg.cc: Adjust line number.

From-SVN: r168046
parent f3fb6590
2010-11-18 Benjamin Kosnik <bkoz@redhat.com>
* config/*/*: Use headername alias to associate private includes
to public includes.
* include/*/*: Same.
* scripts/run_doxygen: Update for doxygen 1.7.2.
* doc/doxygen/user.cfg.in: Same.
* doc/doxygen/TODO: Remove.
* testsuite/*/std_c++0x_neg.cc: Adjust line number.
2010-12-17 Paolo Carlini <paolo.carlini@oracle.com>
* include/bits/basic_string.h (operator+(basic_string<>&&,
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file c++allocator.h
/** @file bits/c++allocator.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{memory}
*/
#ifndef _GLIBCXX_CXX_ALLOCATOR_H
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file c++allocator.h
/** @file bits/c++allocator.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{memory}
*/
#ifndef _GLIBCXX_CXX_ALLOCATOR_H
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file c++allocator.h
/** @file bits/c++allocator.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{memory}
*/
#ifndef _GLIBCXX_CXX_ALLOCATOR_H
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file c++allocator.h
/** @file bits/c++allocator.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{memory}
*/
#ifndef _GLIBCXX_CXX_ALLOCATOR_H
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file c++allocator.h
/** @file bits/c++allocator.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{memory}
*/
#ifndef _GLIBCXX_CXX_ALLOCATOR_H
......
......@@ -23,10 +23,6 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ext/atomicity.h
* This file is a GNU extension to the Standard C++ Library.
*/
#include <bits/c++config.h>
#include <bits/atomic_word.h>
......
......@@ -23,10 +23,6 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ext/atomicity.h
* This file is a GNU extension to the Standard C++ Library.
*/
#include <ext/atomicity.h>
#include <ext/concurrence.h>
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file cpu_defines.h
/** @file bits/cpu_defines.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{iosfwd}
*/
#ifndef _GLIBCXX_CPU_DEFINES
......
......@@ -24,6 +24,11 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file bits/cpu_defines.h
* This is an internal header file, included by other library headers.
* Do not attempt to use it directly. @headername{iosfwd}
*/
#ifndef _GLIBCXX_CPU_DEFINES
#define _GLIBCXX_CPU_DEFINES 1
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file cpu_defines.h
/** @file bits/cpu_defines.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{iosfwd}
*/
#ifndef _GLIBCXX_CPU_DEFINES
......
......@@ -27,9 +27,9 @@
// ISO C++ 14882: 27.8 File-based streams
//
/** @file basic_file.h
/** @file bits/basic_file.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{ios}
*/
#ifndef _GLIBCXX_BASIC_FILE_STDIO_H
......
......@@ -23,9 +23,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file c++io.h
/** @file bits/c++io.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{ios}
*/
// c_io_stdio.h - Defines for using "C" stdio.h
......
......@@ -23,9 +23,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file c++locale.h
/** @file bits/c++locale.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -23,9 +23,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file messages_members.h
/** @file bits/messages_members.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -24,9 +24,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file time_members.h
/** @file bits/time_members.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -23,9 +23,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file c++locale_internal.h
/** @file bits/c++locale_internal.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
// Written by Jakub Jelinek <jakub@redhat.com>
......
......@@ -23,9 +23,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file c++locale.h
/** @file bits/c++locale.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -23,9 +23,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file messages_members.h
/** @file bits/messages_members.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -24,9 +24,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file time_members.h
/** @file bits/time_members.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file c++locale.h
/** @file bits/c++locale.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file messages_members.h
/** @file bits/messages_members.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,6 +22,11 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file bits/atomic_word.h
* This is an internal header file, included by other library headers.
* Do not attempt to use it directly. @headername{ext/atomicity.h}
*/
#ifndef _GLIBCXX_ATOMIC_WORD_H
#define _GLIBCXX_ATOMIC_WORD_H 1
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_inline.h
/** @file bits/ctype_inline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_noninline.h
/** @file bits/ctype_noninline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......@@ -89,4 +89,3 @@
}
return __high;
}
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file os_defines.h
/** @file bits/os_defines.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{iosfwd}
*/
#ifndef _GLIBCXX_OS_DEFINES
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_inline.h
/** @file bits/ctype_inline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_noninline.h
/** @file bits/ctype_noninline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file os_defines.h
/** @file bits/os_defines.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{iosfwd}
*/
#ifndef _GLIBCXX_OS_DEFINES
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_inline.h
/** @file bits/ctype_inline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_noninline.h
/** @file bits/ctype_noninline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_inline.h
/** @file bits/ctype_inline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_noninline.h
/** @file bits/ctype_noninline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_inline.h
/** @file bits/ctype_inline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_noninline.h
/** @file bits/ctype_noninline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_inline.h
/** @file bits/ctype_inline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_noninline.h
/** @file bits/ctype_noninline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file error_constants.h
/** @file bits/error_constants.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{system_error}
*/
#ifndef _GLIBCXX_ERROR_CONSTANTS
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file os_defines.h
/** @file bits/os_defines.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{iosfwd}
*/
#ifndef _GLIBCXX_OS_DEFINES
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_inline.h
/** @file bits/ctype_inline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -23,9 +23,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_noninline.h
/** @file bits/ctype_noninline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file error_constants.h
/** @file bits/error_constants.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{system_error}
*/
#ifndef _GLIBCXX_ERROR_CONSTANTS
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file os_defines.h
/** @file bits/os_defines.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{iosfwd}
*/
#ifndef _GLIBCXX_OS_DEFINES
......
......@@ -23,15 +23,15 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file bits/ctype_base.h
* This is an internal header file, included by other library headers.
* Do not attempt to use it directly. @headername{locale}
*/
//
// ISO C++ 14882: 22.1 Locales
//
/** @file ctype_base.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
*/
// Information as gleaned from /usr/include/ctype.h
_GLIBCXX_BEGIN_NAMESPACE(std)
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_inline.h
/** @file bits/ctype_inline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -24,9 +24,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_noninline.h
/** @file bits/ctype_noninline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file os_defines.h
/** @file bits/os_defines.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{iosfwd}
*/
#ifndef _GLIBCXX_OS_DEFINES
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_inline.h
/** @file bits/ctype_inline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -23,9 +23,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_noninline.h
/** @file bits/ctype_noninline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file os_defines.h
/** @file bits/os_defines.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{iosfwd}
*/
#ifndef _GLIBCXX_OS_DEFINES
......
......@@ -22,6 +22,11 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file bits/atomic_word.h
* This is an internal header file, included by other library headers.
* Do not attempt to use it directly. @headername{ext/atomicity.h}
*/
#ifndef _GLIBCXX_ATOMIC_WORD_H
#define _GLIBCXX_ATOMIC_WORD_H 1
......
......@@ -22,6 +22,11 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file bits/ctype_base.h
* This is an internal header file, included by other library headers.
* Do not attempt to use it directly. @headername{locale}
*/
//
// ISO C++ 14882: 22.1 Locales
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_inline.h
/** @file bits/ctype_inline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_noninline.h
/** @file bits/ctype_noninline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......@@ -91,4 +91,3 @@
}
return __high;
}
......@@ -22,6 +22,11 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file bits/os_defines.h
* This is an internal header file, included by other library headers.
* Do not attempt to use it directly. @headername{iosfwd}
*/
#ifndef _GLIBCXX_OS_DEFINES
#define _GLIBCXX_OS_DEFINES 1
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_inline.h
/** @file bits/ctype_inline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -23,9 +23,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_noninline.h
/** @file bits/ctype_noninline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......@@ -234,7 +234,3 @@
}
return __high;
}
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file error_constants.h
/** @file bits/error_constants.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{system_error}
*/
#ifndef _GLIBCXX_ERROR_CONSTANTS
......
......@@ -23,9 +23,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file os_defines.h
/** @file bits/os_defines.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{iosfwd}
*/
#ifndef _GLIBCXX_OS_DEFINES
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_inline.h
/** @file bits/ctype_inline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_noninline.h
/** @file bits/ctype_noninline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......@@ -95,4 +95,3 @@
}
return __high;
}
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file os_defines.h
/** @file bits/os_defines.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{iosfwd}
*/
#ifndef _GLIBCXX_OS_DEFINES
......
......@@ -22,6 +22,11 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file bits/ctype_base.h
* This is an internal header file, included by other library headers.
* Do not attempt to use it directly. @headername{locale}
*/
//
// ISO C++ 14882: 22.1 Locales
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_inline.h
/** @file bits/ctype_inline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_noninline.h
/** @file bits/ctype_noninline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_inline.h
/** @file bits/ctype_inline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -23,9 +23,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_noninline.h
/** @file bits/ctype_noninline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_inline.h
/** @file bits/ctype_inline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_noninline.h
/** @file bits/ctype_noninline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file os_defines.h
/** @file bits/os_defines.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{iosfwd}
*/
#ifndef _GLIBCXX_OS_DEFINES
......
......@@ -23,15 +23,15 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file bits/ctype_base.h
* This is an internal header file, included by other library headers.
* Do not attempt to use it directly. @headername{locale}
*/
//
// ISO C++ 14882: 22.1 Locales
//
/** @file ctype_base.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
*/
// Information as gleaned from /usr/include/ctype.h
_GLIBCXX_BEGIN_NAMESPACE(std)
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_inline.h
/** @file bits/ctype_inline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -23,9 +23,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_noninline.h
/** @file bits/ctype_noninline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file os_defines.h
/** @file bits/os_defines.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{iosfwd}
*/
#ifndef _GLIBCXX_OS_DEFINES
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_inline.h
/** @file bits/ctype_inline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -23,9 +23,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file ctype_noninline.h
/** @file bits/ctype_noninline.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file os_defines.h
/** @file bits/os_defines.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{iosfwd}
*/
#ifndef _GLIBCXX_OS_DEFINES
......
The approach I've been using for a given header is to recursively do each
of the "bits" headers which make up the standard header. So, e.g., while
there are four headers making up <algorithm>, three of them were already
documented in the course of doing other headers.
"Untouched" means I've deliberately skipped it for various reasons, or
haven't gotten to it yet. It /will/ be done (by somebody, eventually.)
If you document an area and need to skip (for whatever reason) a non-trivial
entity (i.e., one that should be documented), go ahead and add the comment
markup, and use the homegrown @doctodo tag. See include/bits/stl_iterator.h
for examples of this. Doing so will at least cause doxygen to consider the
entitiy as documented and include it in the output. It will also add the
entity to the generated TODO page.
Area Still needs to be doxygen-documented
-----------------------------------------------------------
c17 FINISHED (Nothing in Clause 17 "exists" in terms of code.)
c18 FINISHED, Note A
c19 Note A
c20 Note A
c21 Public functions basic_string done, Note B
c22 Most still to do; see docs/html/22_locale/*
c23 See doxygroups.cc and Note B. Notes on what invalidates
iterators need to be added.
c24 stl_iterator.h (__normal_iterator, other small TODO bits)
stream iterators
c25 stl_algo.h (lots of stuff)
c26 <complex>, <valarray>, stl_numeric.h[26.4], Note A
c27 ios_base callbacks and local storage
basic_ios::copyfmt()
std_streambuf.h's __copy_streambufs()
" " _M_* protected memfns (data has been done)
fstream and sstream protected members
backward/* Not scanned by doxygen. Should it be? Doubtful.
ext/* Some of the SGI algorithm/functional extensions.
All of rope/hashing/slist need docs.
__gnu_cxx Tricky. Right now ext/* are in this namespace.
-----------------------------------------------------------
NOTES:
A) So far I have not tried to document any of the <c*> headers. So entities
such as atexit() are undocumented throughout the library. Since we usually
do not have the C code (to which the doxygen comments would be attached),
this would need to be done in entirely separate files, a la doxygroups.cc.
B) Huge chunks of containers and strings are described in common "Tables"
in the standard. These are pseudo-duplicated in tables.html. We can
use doxygen hooks like @pre and @see to reference the tables. Then the
individual classes do like the standard does, and only document members for
which additional info is available.
STYLE:
stl_deque.h, stl_pair.h, and stl_algobase.h have good examples of what I've
been using for class, namespace-scope, and function documentation, respectively.
These should serve as starting points. /Please/ maintain the inter-word and
inter-sentence spacing, as this might be generated and/or scanned in the
future.
vim:ts=4:et:
......@@ -24,7 +24,7 @@
/** @file bits/algorithmfwd.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{algorithm}
*/
#ifndef _GLIBCXX_ALGORITHMFWD_H
......
......@@ -36,9 +36,9 @@
* purpose. It is provided "as is" without express or implied warranty.
*/
/** @file allocator.h
/** @file bits/allocator.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{memory}
*/
#ifndef _ALLOCATOR_H
......
......@@ -25,7 +25,7 @@
/** @file bits/atomic_0.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{atomic}
*/
#ifndef _GLIBCXX_ATOMIC_0_H
......
......@@ -25,7 +25,7 @@
/** @file bits/atomic_2.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{atomic}
*/
#ifndef _GLIBCXX_ATOMIC_2_H
......
......@@ -24,7 +24,7 @@
/** @file bits/atomic_base.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{atomic}
*/
#ifndef _GLIBCXX_ATOMIC_BASE_H
......
......@@ -24,9 +24,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file basic_ios.h
/** @file bits/basic_ios.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{ios}
*/
#ifndef _BASIC_IOS_H
......
......@@ -23,9 +23,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file basic_ios.tcc
/** @file bits/basic_ios.tcc
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{ios}
*/
#ifndef _BASIC_IOS_TCC
......
......@@ -24,9 +24,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file basic_string.h
/** @file bits/basic_string.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{string}
*/
//
......
......@@ -24,9 +24,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file basic_string.tcc
/** @file bits/basic_string.tcc
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{string}
*/
//
......
......@@ -30,9 +30,9 @@
// to its suitability for any purpose.
//
/** @file boost_concept_check.h
/** @file bits/boost_concept_check.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{iterator}
*/
// GCC Note: based on version 1.12.0 of the Boost library.
......
......@@ -20,8 +20,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file c++0x_warning.h
* This is a Standard C++ Library header.
/** @file bits/c++0x_warning.h
* This is an internal header file, included by other library headers.
* Do not attempt to use it directly. @headername{iosfwd}
*/
#ifndef _CXX0X_WARNING_H
......
......@@ -23,9 +23,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file c++config.h
/** @file bits/c++config.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{iosfwd}
*/
#ifndef _GLIBCXX_CXX_CONFIG_H
......
......@@ -24,9 +24,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file char_traits.h
/** @file bits/char_traits.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{string}
*/
//
......
......@@ -25,7 +25,7 @@
/** @file bits/codecvt.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{locale}
*/
//
......
......@@ -22,9 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file concept_check.h
/** @file bits/concept_check.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{iterator}
*/
#ifndef _CONCEPT_CHECK_H
......
......@@ -23,9 +23,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file cpp_type_traits.h
/** @file bits/cpp_type_traits.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{ext/type_traits}
*/
// Written by Gabriel Dos Reis <dosreis@cmla.ens-cachan.fr>
......
......@@ -50,9 +50,9 @@
* purpose. It is provided "as is" without express or implied warranty.
*/
/** @file deque.tcc
/** @file bits/deque.tcc
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
* Do not attempt to use it directly. @headername{deque}
*/
#ifndef _DEQUE_TCC
......
......@@ -22,8 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file forward_list.h
* This is a Standard C++ Library header.
/** @file bits/forward_list.h
* This is an internal header file, included by other library headers.
* Do not attempt to use it directly. @headername{forward_list}
*/
#ifndef _FORWARD_LIST_H
......
......@@ -22,8 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file forward_list.tcc
* This is a Standard C++ Library header.
/** @file bits/forward_list.tcc
* This is an internal header file, included by other library headers.
* Do not attempt to use it directly. @headername{forward_list}
*/
#ifndef _FORWARD_LIST_TCC
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment