Fix some more doxygen issues.

1. I now get a warning about paper sizes with doxygen 1.8.18:

warning: argument 'a4wide' for option PAPER_TYPE is not a valid enum value
Using the default: a4!

   Get around this by just using a4.

2. My LaTeX distribution already defines vcentcolon, so rename our own version
   to dealvcentcolon to preserve compatibility with older tex distributions.

3. Use mathrm instead of text to get underscores to work correctly with
   backslashes with both MathJax and LaTeX. This is the solution we use
   elsewhere in the library.

diff --git a/doc/doxygen/extra.sty b/doc/doxygen/extra.sty
index 36801f63253f75fdf33408728af9d5be43215ab4..3e688da0ed00466941c3acd473a5a395c44fe92c 100644 (file)
--- a/doc/doxygen/extra.sty
+++ b/doc/doxygen/extra.sty
@@ -18,7 +18,7 @@
 
 % Note: If you add an entry here, also put it into
 % ./doc/doxygen/scripts/mod_header.pl.in
-\newcommand{\vcentcolon}{\mathrel{\mathop{:}}}
-\newcommand{\dealcoloneq}{\vcentcolon\mathrel{\mkern-1.2mu}=}
+\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}
+\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}
 \newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}
 \newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}

diff --git a/doc/doxygen/options.dox.in b/doc/doxygen/options.dox.in
index 3d276f68daf190ff12c91ab38515f7dcb47970e1..d0147c5490f3e6eedcf9de8d83e928e28f097857 100644 (file)
--- a/doc/doxygen/options.dox.in
+++ b/doc/doxygen/options.dox.in
@@ -134,7 +134,7 @@ GENERATE_LATEX         = NO
 
 # but set a few flags for when processing formulas embedded
 # in the documentation.
-PAPER_TYPE             = a4wide
+PAPER_TYPE             = a4
 EXTRA_PACKAGES         = amsmath amsfonts mathtools @_extra_packages@
 LATEX_BATCHMODE        = YES
 

diff --git a/doc/doxygen/scripts/mod_header.pl.in b/doc/doxygen/scripts/mod_header.pl.in
index ab680e094248097da6a064d293e6de7c7a4e5ad5..dc45c51b0f5bb6c2fb8321a2ef2d10b50a277293 100644 (file)
--- a/doc/doxygen/scripts/mod_header.pl.in
+++ b/doc/doxygen/scripts/mod_header.pl.in
@@ -43,8 +43,8 @@ if (eof)
 {
     print '<!--Extra macros for MathJax:-->', "\n";
     print '<div style="display:none">', "\n";
-    print '\(\newcommand{\vcentcolon}{\mathrel{\mathop{:}}}\)', "\n";
-    print '\(\newcommand{\dealcoloneq}{\vcentcolon\mathrel{\mkern-1.2mu}=}\)', "\n";
+    print '\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\)', "\n";
+    print '\(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\)', "\n";
     print '\(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\)', "\n";
     print '\(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)', "\n";
     print '</div>', "\n";

diff --git a/include/deal.II/lac/linear_operator.h b/include/deal.II/lac/linear_operator.h
index d7c855ff3adbd197c24ceb17ebb2255a64344ba3..2274e53a7667e4d9dc3aafc49d631672d6b01d06 100644 (file)
--- a/include/deal.II/lac/linear_operator.h
+++ b/include/deal.II/lac/linear_operator.h
@@ -370,8 +370,8 @@ public:
  * @relatesalso LinearOperator
  *
  * Addition of two linear operators @p first_op and @p second_op given by
- * $(\text{first_op}+\text{second_op})x \dealcoloneq \text{first_op}(x) +
- * \text{second_op}(x)$
+ * $(\mathrm{first\_op}+\mathrm{second\_op})x \dealcoloneq \mathrm{first\_op}(x)
+ * + \mathrm{second\_op}(x)$
  *
  * @ingroup LAOperators
  */
@@ -429,8 +429,8 @@ operator+(const LinearOperator<Range, Domain, Payload> &first_op,
  * @relatesalso LinearOperator
  *
  * Subtraction of two linear operators @p first_op and @p second_op given by
- * $(\text{first_op}-\text{second_op})x \dealcoloneq \text{first_op}(x) -
- * \text{second_op}(x)$
+ * $(\mathrm{first\_op}-\mathrm{second\_op})x \dealcoloneq \mathrm{first\_op}(x)
+ * - \mathrm{second\_op}(x)$
  *
  * @ingroup LAOperators
  */
@@ -564,8 +564,8 @@ operator*(const LinearOperator<Range, Domain, Payload> &op,
  * @relatesalso LinearOperator
  *
  * Composition of two linear operators @p first_op and @p second_op given by
- * $(\text{first_op}*\text{second_op})x \dealcoloneq
- * \text{first_op}(\text{econd_op}(x))$
+ * $(\mathrm{first\_op}*\mathrm{second\_op})x \dealcoloneq
+ * \mathrm{first\_op}(\mathrm{second\_op}(x))$
  *
  * @ingroup LAOperators
  */