From: Timo Heister Date: Sun, 12 May 2019 17:37:47 +0000 (-0600) Subject: fix doxygen problems X-Git-Tag: v9.1.0-rc1~39^2~5 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6b7fa5d9c7952a4bc1bb6f4ed3d6a2beb4ad6e15;p=dealii.git fix doxygen problems --- diff --git a/include/deal.II/algorithms/general_data_storage.h b/include/deal.II/algorithms/general_data_storage.h index dfbc3bd073..b98d68c5a5 100644 --- a/include/deal.II/algorithms/general_data_storage.h +++ b/include/deal.II/algorithms/general_data_storage.h @@ -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 std::string<\tt> key listed first + * individual line, with the std::string key listed first * followed by the demangled type_id of the associated mapped * type. */ diff --git a/include/deal.II/base/parsed_convergence_table.h b/include/deal.II/base/parsed_convergence_table.h index 8fd6d75c80..f25ce91f7f 100644 --- a/include/deal.II/base/parsed_convergence_table.h +++ b/include/deal.II/base/parsed_convergence_table.h @@ -294,7 +294,7 @@ public: const Function *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(); diff --git a/include/deal.II/differentiation/sd/symengine_number_types.h b/include/deal.II/differentiation/sd/symengine_number_types.h index ddfcc1128c..56bed0ba9f 100644 --- a/include/deal.II/differentiation/sd/symengine_number_types.h +++ b/include/deal.II/differentiation/sd/symengine_number_types.h @@ -747,7 +747,7 @@ namespace Differentiation * type. This could be achieved with an overriding conversion function * in the base class, for example: * - * + * @code * class MyNumber : public Expression * { * ... @@ -766,7 +766,7 @@ namespace Differentiation * return Expression::operator ResultType(); * } * } - * + * @endcode */ template explicit operator ResultType() const; diff --git a/include/deal.II/differentiation/sd/symengine_scalar_operations.h b/include/deal.II/differentiation/sd/symengine_scalar_operations.h index 257adb0005..fa109c4da1 100644 --- a/include/deal.II/differentiation/sd/symengine_scalar_operations.h +++ b/include/deal.II/differentiation/sd/symengine_scalar_operations.h @@ -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 @p 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 @p 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 @p 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: * diff --git a/include/deal.II/meshworker/scratch_data.h b/include/deal.II/meshworker/scratch_data.h index 5201f11ede..2c190d8ddd 100644 --- a/include/deal.II/meshworker/scratch_data.h +++ b/include/deal.II/meshworker/scratch_data.h @@ -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