]> https://gitweb.dealii.org/ - dealii.git/commitdiff
fix a number of doxygen issues 826/head
authorTimo Heister <timo.heister@gmail.com>
Fri, 17 Apr 2015 18:46:20 +0000 (14:46 -0400)
committerTimo Heister <timo.heister@gmail.com>
Fri, 17 Apr 2015 18:46:20 +0000 (14:46 -0400)
doc/doxygen/tutorial/tutorial.h.in
doc/news/changes.h
include/deal.II/lac/lapack_full_matrix.h
include/deal.II/lac/trilinos_precondition.h
include/deal.II/numerics/vector_tools.h

index e6b462b5ab0e92e0ce83cb5902cc3601050b2fb3..ec335444537784af184d50ea93898daaa349fe6a 100644 (file)
  * @enddot
  *
  * <b>Legend:</b><br />
- * <blockquote>
- * <i>Green:</i> programs that show basic techniques; <br />
- * <i>Orange:</i> advanced techniques; <br />
- * <i>Yellow:</i> applications in fluid dynamics; <br />
- * <i>Light blue:</i> applications in solid mechanics; <br />
- * <i>Dark blue:</i> time dependent problems.
- * </blockquote>
+ * <ul>
+ *
+ * <li><i>Green:</i> programs that show basic techniques;
+ *
+ * <li><i>Orange:</i> advanced techniques;
+ *
+ * <li><i>Yellow:</i> applications in fluid dynamics;
+ *
+ * <li><i>Light blue:</i> applications in solid mechanics;
+ *
+ * <li><i>Dark blue:</i> time dependent problems.
+ *
+ * </ul>
  *
  * <a name="list"></a>
  * <h3>Tutorial programs listed by number</h3>
index d3ef58962dafd8beaeed439eded8edadc684fc29..b87680c6f667f4d7968720e2ebe11e20f01321fc 100644 (file)
@@ -59,7 +59,7 @@ inconvenience this causes.
 
   <li> Removed: The CMake configuration does not use the variable
   <code>DEAL_II_CMAKE_MACROS_RELDIR</code> any more. Instead, the fixed
-  location <code>${DEAL_II_SHARE_RELDIR}/macros</code> is used
+  location <code>\${DEAL_II_SHARE_RELDIR}/macros</code> is used
   unconditionally
   <br>
   (Matthias Maier, 2015/03/26)
index 107a03a8efb7acdbe9c3e50e1e09d112d0ff50ac..e8eabb0b1d7326cb78b87c9df70ec4c3d043c101 100644 (file)
@@ -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.
    */
index 7086b42bf5a6fae3227708be21562142a7343f5a..9f064435727e7870714f150f66d42deb7037f634 100644 (file)
@@ -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.
+     *
+     * </ul>
      */
     struct AdditionalData
     {
index 45ad3b067ac23eaadfad57023c308b5ec40a8716..77c8958e71c70b8581d3245b5bdf657d57ef8fea 100644 (file)
@@ -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.
    *

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.