Skip to content

Commit

Permalink
Fix some more doxygen issues.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
drwells committed May 5, 2020
1 parent dd5c780 commit fdb71fa
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions doc/doxygen/extra.sty
Expand Up @@ -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\}}
2 changes: 1 addition & 1 deletion doc/doxygen/options.dox.in
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions doc/doxygen/scripts/mod_header.pl.in
Expand Up @@ -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";
Expand Down
12 changes: 6 additions & 6 deletions include/deal.II/lac/linear_operator.h
Expand Up @@ -370,8 +370,8 @@ class LinearOperator : public Payload
* @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
*/
Expand Down Expand Up @@ -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
*/
Expand Down Expand Up @@ -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
*/
Expand Down

0 comments on commit fdb71fa

Please sign in to comment.