This is the mail archive of the
libstdc++@gcc.gnu.org
mailing list for the libstdc++ project.
[v3] doxygen vs. pdf
- From: Benjamin Kosnik <bkoz at redhat dot com>
- To: gcc-patches at gcc dot gnu dot org, libstdc++ at gcc dot gnu dot org
- Date: Mon, 31 Jan 2011 17:34:59 -0800
- Subject: [v3] doxygen vs. pdf
With PDF_HYPERLINKS requires doxygen-1.7.0. Details in
https://bugzilla.gnome.org/show_bug.cgi?id=641083
Last pass for include vs. headername alias.
tested x86/linux
-benjamin
2011-02-01 Benjamin Kosnik <bkoz@redhat.com>
* scripts/run_doxygen: Allow doxygen 1.7.0 again.
* doc/doxygen/user.cfg.in (PDF_HYPERLINKS): Re-enable.
(COMPACT_LATEX): Enable.
* include/profile/impl/profiler_container_size.h: Adjust doxygen markup.
* include/profile/impl/profiler_hash_func.h: Same.
* include/bits/hashtable.h: Same.
* include/backward/auto_ptr.h: Same.
* include/backward/strstream: Same.
* include/backward/backward_warning.h: Same.
* include/backward/binders.h: Same.
Index: scripts/run_doxygen
===================================================================
--- scripts/run_doxygen (revision 169463)
+++ scripts/run_doxygen (working copy)
@@ -1,7 +1,7 @@
#!/bin/bash
# Runs doxygen and massages the output files.
-# Copyright (C) 2001, 2002, 2003, 2004, 2008, 2009, 2010
+# Copyright (C) 2001, 2002, 2003, 2004, 2008, 2009, 2010, 2011
# Free Software Foundation, Inc.
#
# Synopsis: run_doxygen --mode=[html|latex|man|xml] --host_alias=<alias> \
@@ -13,7 +13,7 @@
# We can check now that the version of doxygen is >= this variable.
-DOXYVER=1.7.1
+DOXYVER=1.7.0
find_doxygen() {
local -r v_required=`echo $DOXYVER | \
Index: doc/doxygen/user.cfg.in
===================================================================
--- doc/doxygen/user.cfg.in (revision 169463)
+++ doc/doxygen/user.cfg.in (working copy)
@@ -586,12 +586,8 @@
INPUT = @srcdir@/doc/doxygen/doxygroups.cc \
@srcdir@/libsupc++/cxxabi.h \
- @srcdir@/libsupc++/cxxabi_forced.h \
@srcdir@/libsupc++/exception \
- @srcdir@/libsupc++/exception_defines.h \
- @srcdir@/libsupc++/exception_ptr.h \
@srcdir@/libsupc++/initializer_list \
- @srcdir@/libsupc++/nested_exception.h \
@srcdir@/libsupc++/new \
@srcdir@/libsupc++/typeinfo \
include/algorithm \
@@ -1279,7 +1275,7 @@
# LaTeX documents. This may be useful for small projects and may help to
# save some trees in general.
-COMPACT_LATEX = NO
+COMPACT_LATEX = YES
# The PAPER_TYPE tag can be used to set the paper type that is used
# by the printer. Possible values are: a4, letter, legal and
@@ -1304,7 +1300,7 @@
# contain links (just like the HTML output) instead of page references
# This makes the output suitable for online browsing using a pdf viewer.
-PDF_HYPERLINKS = NO
+PDF_HYPERLINKS = YES
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
# plain latex in the generated Makefile. Set this option to YES to get a
Index: include/profile/impl/profiler_container_size.h
===================================================================
--- include/profile/impl/profiler_container_size.h (revision 169463)
+++ include/profile/impl/profiler_container_size.h (working copy)
@@ -1,6 +1,6 @@
// -*- C++ -*-
//
-// Copyright (C) 2009, 2010 Free Software Foundation, Inc.
+// Copyright (C) 2009, 2010, 2011 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the terms
@@ -28,7 +28,7 @@
// reasons why the executable file might be covered by the GNU General
// Public License.
-/** @file profile/impl/profiler_trace.h
+/** @file profile/impl/profiler_container_size.h
* @brief Diagnostics for container sizes.
*/
Index: include/profile/impl/profiler_hash_func.h
===================================================================
--- include/profile/impl/profiler_hash_func.h (revision 169463)
+++ include/profile/impl/profiler_hash_func.h (working copy)
@@ -1,6 +1,6 @@
// -*- C++ -*-
//
-// Copyright (C) 2009, 2010 Free Software Foundation, Inc.
+// Copyright (C) 2009, 2010, 2011 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the terms
@@ -28,7 +28,7 @@
// reasons why the executable file might be covered by the GNU General
// Public License.
-/** @file profile/impl/profiler_trace.h
+/** @file profile/impl/profiler_hash_func.h
* @brief Data structures to represent profiling traces.
*/
Index: include/bits/hashtable.h
===================================================================
--- include/bits/hashtable.h (revision 169463)
+++ include/bits/hashtable.h (working copy)
@@ -24,8 +24,7 @@
/** @file bits/hashtable.h
* This is an internal header file, included by other library headers.
- * You should not attempt to use it directly.
- * @headername{unordered_map, unordered_set}
+ * Do not attempt to use it directly. @headername{unordered_map, unordered_set}
*/
#ifndef _HASHTABLE_H
Index: include/backward/auto_ptr.h
===================================================================
--- include/backward/auto_ptr.h (revision 169463)
+++ include/backward/auto_ptr.h (working copy)
@@ -24,7 +24,7 @@
/** @file backward/auto_ptr.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 _BACKWARD_AUTO_PTR_H
Index: include/backward/strstream
===================================================================
--- include/backward/strstream (revision 169463)
+++ include/backward/strstream (working copy)
@@ -1,6 +1,6 @@
// Backward-compat support -*- C++ -*-
-// Copyright (C) 2001, 2002, 2004, 2005, 2009, 2010
+// Copyright (C) 2001, 2002, 2004, 2005, 2009, 2010, 2011
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
@@ -41,6 +41,11 @@
// MAY BE REMOVED in a future standard revision. One should use the
// header <sstream> instead.
+/** @file backward/strstream
+ * This is an internal header file, included by other library headers.
+ * Do not attempt to use it directly. @headername{sstream}
+ */
+
#ifndef _BACKWARD_STRSTREAM
#define _BACKWARD_STRSTREAM
Index: include/backward/backward_warning.h
===================================================================
--- include/backward/backward_warning.h (revision 169463)
+++ include/backward/backward_warning.h (working copy)
@@ -1,4 +1,4 @@
-// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
+// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2011
// Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
@@ -21,6 +21,11 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
+/** @file backward/backward_warning.h
+ * This is an internal header file, included by other library headers.
+ * Do not attempt to use it directly. @headername{iosfwd}
+ */
+
#ifndef _BACKWARD_BACKWARD_WARNING_H
#define _BACKWARD_BACKWARD_WARNING_H 1
Index: include/backward/binders.h
===================================================================
--- include/backward/binders.h (revision 169463)
+++ include/backward/binders.h (working copy)
@@ -51,7 +51,7 @@
/** @file backward/binders.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{functional}
*/
#ifndef _BACKWARD_BINDERS_H