]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix a doxygen issue with quoted italics. 1460/head
authorDavid Wells <wellsd2@rpi.edu>
Fri, 28 Aug 2015 21:48:24 +0000 (17:48 -0400)
committerDavid Wells <wellsd2@rpi.edu>
Fri, 28 Aug 2015 21:48:24 +0000 (17:48 -0400)
Under certain circumstances Doxygen treats text surrounded by double
quotes as a verbatim environment, e.g., doxygen will convert '<i>' into
'&lt;i%gt;', which is not what we want when italicising text.

doc/doxygen/headers/update_flags.h
doc/news/8.1.0-vs-8.2.0.h

index 9136e245c11ccf17f4d4d160984e7b3429508215..593257073591957c07ef45ab47f4e3c7852eef6f 100644 (file)
@@ -88,9 +88,9 @@
  * producing a <i>set of flags</i> amounts to setting multiple bits
  * in an integer, which is facilitated using the operation
  * <code>update_gradients | update_JxW_values</code> (in other words, and
- * maybe slightly confusingly so, the operation "this operation <i>and</i> that
- * operation" is represented by the expression "single-bit-in-an-integer-for-this-operation
- * <i>binary-or</i> single-bit-in-an-integer-for-that-operation"). To
+ * maybe slightly confusingly so, the operation @"this operation <i>and</i> that
+ * operation@" is represented by the expression @"single-bit-in-an-integer-for-this-operation
+ * <i>binary-or</i> single-bit-in-an-integer-for-that-operation@"). To
  * make operations cheaper, FEValues and the mapping and finite element objects
  * it depends on really only compute those pieces of information that you
  * have specified in the update flags (plus some information necessary to
index dd3959066beccc69c99de012e5d6a37b291731cb..8cc6872109f8728f048c88c8faa0a1b50498e9e4 100644 (file)
@@ -50,14 +50,14 @@ inconvenience this causes.
 
   <li> Removed: The constructor of the Utilities::MPI::MPI_InitFinalize
   class used to interpret a last argument equal to numbers::invalid_unsigned_int
-  as "<i>create as many threads as there are processor cores on the current
-  system</i>" for each MPI process. If there were multiple MPI processes on a
+  as @"<i>create as many threads as there are processor cores on the current
+  system</i>@" for each MPI process. If there were multiple MPI processes on a
   given node, this would lead to (sometimes massive) overallocation of resources
   because <i>every</i> MPI process would create as many threads as there are cores.
   This has now been changed: an argument equal to numbers::invalid_unsigned_int
-  is now interpreted as "<i>subdivide the available cores between all MPI
+  is now interpreted as @"<i>subdivide the available cores between all MPI
   processes running on the current system and let each process create as many
-  threads as cores were allocated to it</i>".
+  threads as cores were allocated to it</i>@".
   <br>
   (Wolfgang Bangerth, 2014/09/16)
   </li>

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.