From patchwork Tue Nov 20 11:44:48 2012
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: escape sharp brackets to avoid doxygen warnings
Date: Tue, 20 Nov 2012 01:44:48 -0000
From: Jonathan Wakely <jwakely.gcc@gmail.com>
X-Patchwork-Id: 200308
Message-Id: <CAH6eHdQRHfcbRneMzdL4FfYwOgrEJtX3rf_LF0x-V9B+fO-XRg@mail.gmail.com>
To: Matthias Klose <doko@ubuntu.com>
Cc: "libstdc++@gcc.gnu.org" <libstdc++@gcc.gnu.org>,
 gcc-patches <gcc-patches@gcc.gnu.org>

On 18 November 2012 16:59, Matthias Klose wrote:
> currently doxygen complains about unknown xml/html tags. this patch properly(?)
> escapes these. Maybe this is a change in doxygen 1.8, it didn't seem to be
> necessary in the past. Ok for the trunk?

(Added gcc-patches to the CC list)

OK, thanks.


2012-11-18  Matthias Klose  <doko@ubuntu.com>

	* doc/doxygen/user.cfg.in (ALIASES). Escape sharp braces.
	* include/bits/allocator.h: Escape sharp braces in comment.
	* include/profile/impl/profiler_algos.h: Likewise.

Index: doc/doxygen/user.cfg.in
===================================================================
--- doc/doxygen/user.cfg.in	(revision 193528)
+++ doc/doxygen/user.cfg.in	(working copy)
@@ -196,8 +196,8 @@
 # You can put \n's in the value part of an alias to insert newlines.
 
 ALIASES                = "doctodo=@todo\nNeeds documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html" \
-                         "headername{1}=Instead, include <\1>." \
-                         "headername{2}=Instead, include <\1> or <\2>."
+                         "headername{1}=Instead, include \<\1\>." \
+                         "headername{2}=Instead, include \<\1\> or \<\2\>."
 
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 # A mapping has the form "name=value". For example adding
Index: include/profile/impl/profiler_algos.h
===================================================================
--- include/profile/impl/profiler_algos.h	(revision 193528)
+++ include/profile/impl/profiler_algos.h	(working copy)
@@ -24,7 +24,7 @@
 /** @file profile/impl/profiler_algos.h
  *  @brief Algorithms used by the profile extension.
  *
- *  This file is needed to avoid including <algorithm> or <bits/stl_algo.h>.
+ *  This file is needed to avoid including \<algorithm\> or \<bits/stl_algo.h\>.
  *  Including those files would result in recursive includes.
  *  These implementations are oversimplified.  In general, efficiency may be
  *  sacrificed to minimize maintenance overhead.
Index: include/bits/allocator.h
===================================================================
--- include/bits/allocator.h	(revision 193528)
+++ include/bits/allocator.h	(working copy)
@@ -136,7 +136,7 @@
     operator!=(const allocator<_Tp>&, const allocator<_Tp>&)
     { return false; }
 
-  /// Declare uses_allocator so it can be specialized in <queue> etc.
+  /// Declare uses_allocator so it can be specialized in \<queue\> etc.
   template<typename, typename>
     struct uses_allocator;