From fdb71fa45d7e44a36aa1dac2ed6464007e975935 Mon Sep 17 00:00:00 2001 From: David Wells Date: Tue, 5 May 2020 15:06:58 -0400 Subject: [PATCH] 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. --- doc/doxygen/extra.sty | 4 ++-- doc/doxygen/options.dox.in | 2 +- doc/doxygen/scripts/mod_header.pl.in | 4 ++-- include/deal.II/lac/linear_operator.h | 12 ++++++------ 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/doxygen/extra.sty b/doc/doxygen/extra.sty index 36801f6325..3e688da0ed 100644 --- 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 3d276f68da..d0147c5490 100644 --- 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 ab680e0942..dc45c51b0f 100644 --- a/doc/doxygen/scripts/mod_header.pl.in +++ b/doc/doxygen/scripts/mod_header.pl.in @@ -43,8 +43,8 @@ if (eof) { print '', "\n"; print '
', "\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 '
', "\n"; diff --git a/include/deal.II/lac/linear_operator.h b/include/deal.II/lac/linear_operator.h index d7c855ff3a..2274e53a76 100644 --- 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 &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 &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 */ -- 2.39.5