Fix HTML source documenation error caused by GaussTransform3D
authorChristian Blau <cblau@gwdg.de>
Tue, 23 Jul 2019 15:26:38 +0000 (17:26 +0200)
committerChristian Blau <cblau@gwdg.de>
Wed, 24 Jul 2019 14:57:47 +0000 (16:57 +0200)
In doxygen/html-full/annotated.xhtml, doxygen generated an invalid
xhtml file with the following error on line 724 at column 493:

Opening and ending tag mismatch: td line 0 and p

This patch fixes the error by changing the math rendering from
multi-line to single line.

It further removes superfluous * in the verbatim comment of same
class.

Change-Id: I80996743743758095ceac78c519fbec88da9f772

src/gromacs/math/gausstransform.h

index fd1d618252d3a0c9cd21a74ed8583f1060e6dd55..bc445ef085142b3ce44e892e5921dc847259e305 100644 (file)
@@ -152,16 +152,13 @@ struct GaussianSpreadKernelParameters
 };
 
 /*! \libinternal \brief Sums Gaussian values at three dimensional lattice coordinates.
- * The Gaussian is defined as
- * \f[
- *      A * \frac{1}{\sigma^3 \sqrt(2^3*\pi^3)} * \exp(-\frac{(x-x0)^2}{2 \sigma^2})
- * \f]
- * \verbatim
- *  x0:              X           x
- *                 /   \        / \
- *               --     --    --   --
- *  lattice: |    |    |    |    |    |    |
- * \endverbatim
+ * The Gaussian is defined as \f$A \frac{1}{\sigma^3 \sqrt(2^3\pi^3)} * \exp(-\frac{(x-x0)^2}{2 \sigma^2})\f$
+   \verbatim
+   x0:              X           x
+               /   \        / \
+             --     --    --   --
+   lattice: |    |    |    |    |    |    |
+   \endverbatim
  * The lattice has spacing 1, all coordinates are given with respect to the lattice
  * coordinates.
  */