]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix some simple doxygen warnings. 12218/head
authorDavid Wells <drwells@email.unc.edu>
Sun, 16 May 2021 16:22:23 +0000 (12:22 -0400)
committerDavid Wells <drwells@email.unc.edu>
Sun, 16 May 2021 16:22:23 +0000 (12:22 -0400)
include/deal.II/base/parameter_handler.h
include/deal.II/differentiation/sd/symengine_types.h
include/deal.II/fe/fe_system.h

index 1e2c93f1fc464242186a5d70a494ee2dd4aa36cf..4d0bb9b94b1ab68bf94f0b04c373e6dabbae8d60 100644 (file)
@@ -1344,7 +1344,7 @@ public:
   /**
    * Same as above, but an overload where the second argument is a character
    * pointer. This is necessary, since otherwise the call to
-   * <tt>set("abc","def")</code> will be mapped to the function taking one
+   * <code>set("abc","def")</code> will be mapped to the function taking one
    * string and a bool as arguments, which is certainly not what is most often
    * intended.
    *
index 0eb36f3af2558b9f8a458a2f06d76a2f391d81a9..1247df71f16c2919f5fb5f50734f88c37fdf5567 100644 (file)
@@ -53,10 +53,9 @@ namespace Differentiation
       /**
        * Type definition for a value substitution map.
        *
-       * This serves the same purpose as a
-       * <code>SymEngine::map_basic_basic</code>, which is equivalent to a
-       * <code>std::map<SymEngine::RCP<const SymEngine::Basic>,
-       * SymEngine::RCP<const SymEngine::Basic>></code>.
+       * This serves the same purpose as a `SymEngine::map_basic_basic`, which
+       * is equivalent to a `std::map<SymEngine::RCP<const SymEngine::Basic>,
+       * SymEngine::RCP<const SymEngine::Basic>>`.
        */
       using substitution_map =
         std::map<SD::Expression, SD::Expression, internal::ExpressionKeyLess>;
@@ -64,9 +63,8 @@ namespace Differentiation
       /**
        * Type definition for a vector of symbols.
        *
-       * This serves the same purpose as a <code>SymEngine::vec_basic</code>,
-       * which is equivalent to a <code>std::vector<SymEngine::RCP<const
-       * SymEngine::Basic>></code>
+       * This serves the same purpose as a `SymEngine::vec_basic`, which is
+       * equivalent to a `std::vector<SymEngine::RCP<const SymEngine::Basic>>`.
        */
       using symbol_vector = std::vector<SD::Expression>;
 
index 259098e443df48bed3e478ccc49586fa012fcddd..70cc62094026264ccf43509c1bf72c692c31357b 100644 (file)
@@ -810,9 +810,9 @@ public:
    * here.
    *
    * The matrix @p P is the concatenation or the sum of the cell matrices @p
-   * P_i, depending on the #restriction_is_additive_flags. This distinguishes
-   * interpolation (concatenation) and projection with respect to scalar
-   * products (summation).
+   * P_i, depending on the value of FiniteElement::restriction_is_additive().
+   * This distinguishes interpolation (concatenation) and projection with
+   * respect to scalar products (summation).
    *
    * Row and column indices are related to coarse grid and fine grid spaces,
    * respectively, consistent with the definition of the associated operator.

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.