From: Timo Heister Date: Fri, 17 Apr 2015 18:46:20 +0000 (-0400) Subject: fix a number of doxygen issues X-Git-Tag: v8.3.0-rc1~251^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=46372dfa57ed442fe83ad3f173712f20fc5cd416;p=dealii.git fix a number of doxygen issues --- diff --git a/doc/doxygen/tutorial/tutorial.h.in b/doc/doxygen/tutorial/tutorial.h.in index e6b462b5ab..ec33544453 100644 --- a/doc/doxygen/tutorial/tutorial.h.in +++ b/doc/doxygen/tutorial/tutorial.h.in @@ -69,13 +69,19 @@ * @enddot * * Legend:
- *
- * Green: programs that show basic techniques;
- * Orange: advanced techniques;
- * Yellow: applications in fluid dynamics;
- * Light blue: applications in solid mechanics;
- * Dark blue: time dependent problems. - *
+ * * * *

Tutorial programs listed by number

diff --git a/doc/news/changes.h b/doc/news/changes.h index d3ef58962d..b87680c6f6 100644 --- a/doc/news/changes.h +++ b/doc/news/changes.h @@ -59,7 +59,7 @@ inconvenience this causes.
  • Removed: The CMake configuration does not use the variable DEAL_II_CMAKE_MACROS_RELDIR any more. Instead, the fixed - location ${DEAL_II_SHARE_RELDIR}/macros is used + location \${DEAL_II_SHARE_RELDIR}/macros is used unconditionally
    (Matthias Maier, 2015/03/26) diff --git a/include/deal.II/lac/lapack_full_matrix.h b/include/deal.II/lac/lapack_full_matrix.h index 107a03a8ef..e8eabb0b1d 100644 --- a/include/deal.II/lac/lapack_full_matrix.h +++ b/include/deal.II/lac/lapack_full_matrix.h @@ -205,8 +205,8 @@ public: * * @note Source and destination must not be the same vector. * - * @note The template with @tref number2 only exists for compile-time - * compatibility with FullMatrix. Only the case @tref number2 = @tref + * @note The template with @p number2 only exists for compile-time + * compatibility with FullMatrix. Only the case @p number2 = @p * number is implemented due to limitations in the underlying LAPACK * interface. All other variants throw an error upon invocation. */ diff --git a/include/deal.II/lac/trilinos_precondition.h b/include/deal.II/lac/trilinos_precondition.h index 7086b42bf5..9f06443572 100644 --- a/include/deal.II/lac/trilinos_precondition.h +++ b/include/deal.II/lac/trilinos_precondition.h @@ -955,6 +955,8 @@ namespace TrilinosWrappers * will increase communication and storage cost. According to the IFPACK * documentation, an overlap of 1 is often effective and values of more * than 3 are rarely needed. + * + * */ struct AdditionalData { diff --git a/include/deal.II/numerics/vector_tools.h b/include/deal.II/numerics/vector_tools.h index 45ad3b067a..77c8958e71 100644 --- a/include/deal.II/numerics/vector_tools.h +++ b/include/deal.II/numerics/vector_tools.h @@ -1141,12 +1141,12 @@ namespace VectorTools * Once all edge constraints, $x$, have been computed, we may compute the face constraints * in a similar fashion, taking into account the residuals from the edges. * - * For each face on the cell, $f$, we solve the linear system By=c where $y$ is the vector of + * For each face on the cell, $f$, we solve the linear system $By=c$ where $y$ is the vector of * constraints on degrees of freedom on the face and * - * B_{ij} = \int_{f} (\vec{n} \cross \vec{s}_{i}) \cdot (\vec{n} \cross \vec{s}_{j}) dS + * $B_{ij} = \int_{f} (\vec{n} \times \vec{s}_{i}) \cdot (\vec{n} \times \vec{s}_{j}) dS$ * - * $c_{i} = \int_{f} (\vec{n} \cross \vec{r}) \cdot (\vec{n} \cross \vec{s}_i} dS + * $c_{i} = \int_{f} (\vec{n} \times \vec{r}) \cdot (\vec{n} \times \vec{s}_i) dS$ * * and $\vec{r} = \vec{F} - \sum_{e \in f} \sum{i \in e} \x_{i}\vec{s}_i}$, the edge residual. *