]> https://gitweb.dealii.org/ - dealii.git/commitdiff
fix doxygen problems
authorTimo Heister <timo.heister@gmail.com>
Sun, 12 May 2019 17:37:47 +0000 (11:37 -0600)
committerTimo Heister <timo.heister@gmail.com>
Sun, 12 May 2019 17:37:47 +0000 (11:37 -0600)
include/deal.II/algorithms/general_data_storage.h
include/deal.II/base/parsed_convergence_table.h
include/deal.II/differentiation/sd/symengine_number_types.h
include/deal.II/differentiation/sd/symengine_scalar_operations.h
include/deal.II/meshworker/scratch_data.h

index dfbc3bd07362d689c79a2b933a21b5af20c95e58..b98d68c5a50186ba69cbefbe563fa993ab987628 100644 (file)
@@ -87,7 +87,7 @@ public:
    * Print the contents of the internal cache to the @p stream.
    *
    * Each key and value pair in the @p any_data map are printed on an
-   * individual line, with the <tt>std::string<\tt> key listed first
+   * individual line, with the <tt>std::string</tt> key listed first
    * followed by the demangled <tt>type_id</tt> of the associated mapped
    * type.
    */
index 8fd6d75c805d8a5d46e61d381f7ce0a5ede9ed41..f25ce91f7f0fbe260a6e6d71bcf4df10f03448e3 100644 (file)
@@ -294,7 +294,7 @@ public:
     const Function<DoFHandlerType::space_dimension> *weight = nullptr);
 
   /**
-   * Add an additional column (with name @p name) to the table, by invoking
+   * Add an additional column (with name @p column_name) to the table, by invoking
    * the function @p custom_function, when calling error_from_exact() or
    * difference().
    *
@@ -349,7 +349,7 @@ public:
    * @endcode
    *
    *
-   * @param name Name of the column to add;
+   * @param column_name Name of the column to add;
    * @param custom_function Function that will be called to fill the given
    * entry. You need to make sure that the scope of this function is valid
    * up to the call to error_from_exact() or difference();
index ddfcc1128ceda3cd45d5396440ac21d72eb2cea6..56bed0ba9fc9b9645b022d096ec25d1b090f779a 100644 (file)
@@ -747,7 +747,7 @@ namespace Differentiation
        * type. This could be achieved with an overriding conversion function
        * in the base class, for example:
        *
-       * <code>
+       * @code
        *   class MyNumber : public Expression
        *   {
        *     ...
@@ -766,7 +766,7 @@ namespace Differentiation
        *         return Expression::operator ResultType();
        *     }
        *   }
-       * </code>
+       * @endcode
        */
       template <typename ResultType>
       explicit operator ResultType() const;
index 257adb0005f235188a51bc2eba10a53dba9e9d7b..fa109c4da1e310ef0a490180daf0bf47fb6ff174 100644 (file)
@@ -120,7 +120,7 @@ namespace Differentiation
     /**
      * Return the symbolic result of computing the partial derivative of the
      * scalar @p f with respect to the scalar @p x.
-     * In most use cases the function or variable @f would be called the
+     * In most use cases the function or variable @f would be called the
      * dependent variable, and @p x the independent variable.
      *
      * @param[in] f A scalar symbolic function or (dependent) expression.
@@ -977,7 +977,7 @@ namespace Differentiation
      * expression, and that the paired @p symbol_value elements are compatible
      * with the other add_to_substitution_map() functions.
      *
-     * The @p ExpressionType and its associated @ValueType need not be scalar
+     * The @p ExpressionType and its associated @ValueType need not be scalar
      * types. So, for example, this function could be used to add tensor-valued
      * data to the map in the following way:
      *
@@ -1025,7 +1025,7 @@ namespace Differentiation
      * symbolic expressions, and that the paired @p symbol_value elements are
      * compatible with the other add_to_substitution_map() functions.
      *
-     * The @p ExpressionType and its associated @ValueType need not be scalar
+     * The @p ExpressionType and its associated @ValueType need not be scalar
      * types. So, for example, this function could be used to add tensor-valued
      * data to the map in the following way:
      *
index 5201f11ede1e2adc6797421854068b95a5233838..2c190d8ddd0be6357929feac5e0fb36a0acfa0f7 100644 (file)
@@ -285,16 +285,13 @@ namespace MeshWorker
     /**
      * Same as the other constructor, using the default MappingQ1.
      *
-     * @param mapping The mapping to use in the internal FEValues objects
      * @param fe The finite element
      * @param quadrature The cell quadrature
      * @param update_flags UpdateFlags for the current cell FEValues
-     * @param neighbor_update_flags UpdateFlags for the neighbor cell FEValues
      * @param face_quadrature Face quadrature, used for FEFaceFvalues and
      * FESubfaceValues for both the current cell and the neighbor cell
      * @param face_update_flags UpdateFlags used for FEFaceFvalues and
      * FESubfaceValues for the current cell
-     * @param neighbor_face_update_flags UpdateFlags used for FEFaceFvalues and
      * FESubfaceValues for the neighbor cell
      */
     ScratchData(
@@ -307,7 +304,6 @@ namespace MeshWorker
     /**
      * Same as the other constructor, using the default MappingQ1.
      *
-     * @param mapping The mapping to use in the internal FEValues objects
      * @param fe The finite element
      * @param quadrature The cell quadrature
      * @param update_flags UpdateFlags for the current cell FEValues

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.