From: Timo Heister Date: Sun, 10 Sep 2017 16:52:34 +0000 (-0400) Subject: fix doxygen formatting mistakes X-Git-Tag: v9.0.0-rc1~1102^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0ee0eae4093802101f2973911aa200afa86c9c48;p=dealii.git fix doxygen formatting mistakes --- diff --git a/include/deal.II/base/array_view.h b/include/deal.II/base/array_view.h index 6ed21d9dbe..d0d5374658 100644 --- a/include/deal.II/base/array_view.h +++ b/include/deal.II/base/array_view.h @@ -354,7 +354,7 @@ make_array_view (std::vector &vector, * of the ArrayView is inferred from the value type of the iterator (e.g., the * view created from two const iterators will have a const type). * - * @warning The iterators @begin and @p end must bound (in the usual half-open + * @warning The iterators @p begin and @p end must bound (in the usual half-open * way) a contiguous in memory range of values. This function is intended for * use with iterators into containers like * boost::container::small_vector or std::vector and diff --git a/include/deal.II/base/subscriptor.h b/include/deal.II/base/subscriptor.h index 8ca3341e13..9d4c0bcb6c 100644 --- a/include/deal.II/base/subscriptor.h +++ b/include/deal.II/base/subscriptor.h @@ -45,7 +45,7 @@ DEAL_II_NAMESPACE_OPEN * exception's message. These strings are represented as const char * * pointers since the underlying buffer comes from (and is managed * by) the run-time type information system: more exactly, these pointers are - * the result the function call typeid(x).name() where + * the result the function call typeid(x).name() where * x is some object. Therefore, the pointers provided to * subscribe() and to unsubscribe() must be the same. Strings with equal * contents will not be recognized to be the same. The handling in diff --git a/include/deal.II/dofs/dof_handler.h b/include/deal.II/dofs/dof_handler.h index 88dd624249..49c86e92ab 100644 --- a/include/deal.II/dofs/dof_handler.h +++ b/include/deal.II/dofs/dof_handler.h @@ -832,7 +832,7 @@ public: /** * Return a constant reference to the selected finite element object. - * Since there is only one FiniteElement @index must be equal to zero + * Since there is only one FiniteElement @p index must be equal to zero * which is also the default value. */ const FiniteElement & diff --git a/include/deal.II/dofs/dof_tools.h b/include/deal.II/dofs/dof_tools.h index c3ffaa03b4..82c9130e35 100644 --- a/include/deal.II/dofs/dof_tools.h +++ b/include/deal.II/dofs/dof_tools.h @@ -1915,17 +1915,17 @@ namespace DoFTools const bool invert_vertex_mapping = false); /** - * Same as above but allows boundary dofs on blocks to be excluded individually. + * Same as above but allows boundary dofs on blocks to be excluded individually. * - * This is helpful if you want to use, for example, Taylor Hood elements - * as it allows you to not include the boundary DoFs for the velocity - * block on the patches while also letting you include the boundary DoFs - * for the pressure block. + * This is helpful if you want to use, for example, Taylor Hood elements as + * it allows you to not include the boundary DoFs for the velocity block on + * the patches while also letting you include the boundary DoFs for the + * pressure block. * - * @param exclude_boundary_dofs For each patch of cells around a - * vertex, collect all of the interior degrees of freedom of the patch and - * disregard those on the boundary of the patch if the boolean value for - * the corresponding block in the BlockMask is false. + * For each patch of cells around a vertex, collect all of the interior + * degrees of freedom of the patch and disregard those on the boundary of + * the patch if the boolean value for the corresponding block in the + * BlockMask of @p exclude_boundary_dofs is false. */ template std::vector diff --git a/include/deal.II/grid/tria_accessor.h b/include/deal.II/grid/tria_accessor.h index fa69651d49..c680fe72a8 100644 --- a/include/deal.II/grid/tria_accessor.h +++ b/include/deal.II/grid/tria_accessor.h @@ -1387,13 +1387,13 @@ public: * of the object. The barycenter for an object $K$ * of dimension $d$ in $D$ space dimensions is given by the $D$-dimensional * vector $\mathbf x_K$ defined by - * @f{ + * @f[ * \mathbf x_K = \frac{1}{|K|} \int_K \mathbf x \; \textrm{d}x - * @f} + * @f] * where the measure of the object is given by - * @f{ + * @f[ * |K| = \int_K \mathbf 1 \; \textrm{d}x. - * @f} + * @f] * This function assumes that $K$ is mapped by a $d$-linear function from * the reference $d$-dimensional cell. Then the integrals above can be * pulled back to the reference cell and evaluated exactly (if through diff --git a/include/deal.II/matrix_free/evaluation_selector.h b/include/deal.II/matrix_free/evaluation_selector.h index b6824ce492..8757c4119a 100644 --- a/include/deal.II/matrix_free/evaluation_selector.h +++ b/include/deal.II/matrix_free/evaluation_selector.h @@ -343,7 +343,7 @@ template struct SelectEvaluator { /** - * Based on the the run time parameters stored in @shape_info this function + * Based on the the run time parameters stored in @p shape_info this function * chooses an appropriate evaluation strategy for the integrate function, i.e. * this calls internal::FEEvaluationImpl::evaluate(), * internal::FEEvaluationImplCollocation::evaluate() or diff --git a/include/deal.II/matrix_free/matrix_free.h b/include/deal.II/matrix_free/matrix_free.h index f5a38e4949..96771c554a 100644 --- a/include/deal.II/matrix_free/matrix_free.h +++ b/include/deal.II/matrix_free/matrix_free.h @@ -858,8 +858,7 @@ public: * field and separate vectors, ensuring thread safety. The mechanism to * acquire and release objects is similar to the mechanisms used for the * local contributions of WorkStream, see - * @ref workstream_paper "the WorkStream paper" - * . + * @ref workstream_paper "the WorkStream paper". */ AlignedVector > *acquire_scratch_data() const; diff --git a/include/deal.II/multigrid/mg_transfer_matrix_free.h b/include/deal.II/multigrid/mg_transfer_matrix_free.h index 5c86eca492..8af396967d 100644 --- a/include/deal.II/multigrid/mg_transfer_matrix_free.h +++ b/include/deal.II/multigrid/mg_transfer_matrix_free.h @@ -327,9 +327,11 @@ public: const LinearAlgebra::distributed::BlockVector &src) const; /** - * Transfer from a block-vector on the global grid to block-vectors defined on each of the levels separately. + * Transfer from a block-vector on the global grid to block-vectors defined + * on each of the levels separately. * - * This function will initialize @dst accordingly if needed as required by the Multigrid class. + * This function will initialize @p dst accordingly if needed as required by + * the Multigrid class. */ template void diff --git a/include/deal.II/numerics/kdtree.h b/include/deal.II/numerics/kdtree.h index ea8a15be66..34cef87d79 100644 --- a/include/deal.II/numerics/kdtree.h +++ b/include/deal.II/numerics/kdtree.h @@ -43,23 +43,21 @@ DEAL_II_NAMESPACE_OPEN * a given point, or * searching the points that fall within a radius of a target point. * - * @quotation - * From wikipedia (https://en.wikipedia.org/wiki/K-d_tree): - * - * A k-d tree is a binary tree in which every node is a $k$-dimensional point. - * Every non-leaf node can be thought of as implicitly generating a splitting - * hyperplane that divides the space into two parts, known as half-spaces. - * Points to the left of this hyperplane are represented by the left subtree of - * that node and points right of the hyperplane are represented by the right - * subtree. The hyperplane direction is chosen in the following way: every node - * in the tree is associated with one of the $k$-dimensions, with the hyperplane - * perpendicular to that dimension's axis. So, for example, if for a particular - * split the "x" axis is chosen, all points in the subtree with a smaller "x" - * value than the node will appear in the left subtree and all points with - * larger "x" value will be in the right subtree. In such a case, the - * hyperplane would be set by the $x$-value of the point, and its normal would be - * the unit $x$-axis. - * @endquotation + * > From wikipedia (https://en.wikipedia.org/wiki/K-d_tree): + * > + * > A k-d tree is a binary tree in which every node is a $k$-dimensional point. + * > Every non-leaf node can be thought of as implicitly generating a splitting + * > hyperplane that divides the space into two parts, known as half-spaces. + * > Points to the left of this hyperplane are represented by the left subtree of + * > that node and points right of the hyperplane are represented by the right + * > subtree. The hyperplane direction is chosen in the following way: every node + * > in the tree is associated with one of the $k$-dimensions, with the hyperplane + * > perpendicular to that dimension's axis. So, for example, if for a particular + * > split the "x" axis is chosen, all points in the subtree with a smaller "x" + * > value than the node will appear in the left subtree and all points with + * > larger "x" value will be in the right subtree. In such a case, the + * > hyperplane would be set by the $x$-value of the point, and its normal would be + * > the unit $x$-axis. * * @author Luca Heltai, 2017. */ @@ -204,11 +202,11 @@ public: * that are at distance less than or equal to the given radius from * the target point. * - * @param[in] point The target point + * @param[in] target The target point * @param[in] radius The radius of the ball - * @param[in] sorted Sort the output results in ascending order with respect to distances + * @param[in] sorted If @p true, sort the output results in ascending order with respect to distance * - * @return A vector of indices and distances of the matching points + * @return A vector of indices and distances to @p target of the matching points */ std::vector > get_points_within_ball (const Point &target,