From 12d05d03e6d7075d5798df011cbb69e8dae3ebd4 Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Thu, 9 Jul 2015 12:31:36 -0400 Subject: [PATCH] manual formatting This makes doxygen and wrapcomments.py happy --- include/deal.II/dofs/dof_renumbering.h | 3 ++- include/deal.II/grid/tria_accessor.h | 7 +++++-- include/deal.II/lac/arpack_solver.h | 5 +++-- include/deal.II/lac/block_linear_operator.h | 3 ++- include/deal.II/lac/linear_operator.h | 10 ++++++---- include/deal.II/lac/shifted_matrix.h | 8 +++++--- include/deal.II/numerics/vector_tools.h | 6 ++++-- 7 files changed, 27 insertions(+), 15 deletions(-) diff --git a/include/deal.II/dofs/dof_renumbering.h b/include/deal.II/dofs/dof_renumbering.h index 1313295215..caf2695d03 100644 --- a/include/deal.II/dofs/dof_renumbering.h +++ b/include/deal.II/dofs/dof_renumbering.h @@ -536,7 +536,8 @@ namespace DoFRenumbering * that have the smallest number of others that couple with it. * If the DoFHandler is built on a parallel triangulation, then on every * processor, these starting indices need to be a (possibly empty) - * subset of the @ref GlossLocallyOwnedDof "locally owned degrees of freedom". + * subset of the + * @ref GlossLocallyOwnedDof "locally owned degrees of freedom". * These will then be used as starting indices for the local renumbering * on the current processor. (In other words, this argument will in * fact be different on every processor unless you pass an diff --git a/include/deal.II/grid/tria_accessor.h b/include/deal.II/grid/tria_accessor.h index 299ecec436..aac2081527 100644 --- a/include/deal.II/grid/tria_accessor.h +++ b/include/deal.II/grid/tria_accessor.h @@ -2464,8 +2464,11 @@ public: * @note If the triangulation this function is called on is * of type parallel::distributed::Triangulation, then active * cells may be locally owned, ghost cells, or artificial - * (see @ref GlossLocallyOwnedCell , @ref GlossGhostCell , and - * @ref GlossArtificialCell). This function counts over all of + * (see + * @ref GlossLocallyOwnedCell, + * @ref GlossGhostCell, and + * @ref GlossArtificialCell). + * This function counts over all of * them, including ghost and artificial active cells. */ unsigned int active_cell_index () const; diff --git a/include/deal.II/lac/arpack_solver.h b/include/deal.II/lac/arpack_solver.h index cb1783196b..048ff9929a 100644 --- a/include/deal.II/lac/arpack_solver.h +++ b/include/deal.II/lac/arpack_solver.h @@ -82,8 +82,9 @@ extern "C" void dneupd_(int *rvec, char *howmany, int *select, double *d, * matrix rows are all equal to one, you get a single additional * eigenvalue. But beware that some functions in deal.II set these * diagonals to rather arbitrary (from the point of view of - * eigenvalue problems) values. See also @ref step_36 "step-36" for an - * example. + * eigenvalue problems) values. See also + * @ref step_36 "step-36" + * for an example. * * @author Baerbel Janssen, Agnieszka Miedlar, 2010, Guido Kanschat 2015 */ diff --git a/include/deal.II/lac/block_linear_operator.h b/include/deal.II/lac/block_linear_operator.h index 1a93f03f73..6df1d1d8b7 100644 --- a/include/deal.II/lac/block_linear_operator.h +++ b/include/deal.II/lac/block_linear_operator.h @@ -38,7 +38,8 @@ template class BlockVector; * * A function that encapsulates a given collection @p ops of * LinearOperators into a block structure. Hereby, it is assumed that Range - * and Domain are blockvectors, i.e., derived from @ref BlockVectorBase. + * and Domain are blockvectors, i.e., derived from + * @ref BlockVectorBase. * The individual linear operators in @p ops must act on a the underlying * vector type of the block vectors, i.e., on Domain::BlockType yielding a * result in Range::BlockType. diff --git a/include/deal.II/lac/linear_operator.h b/include/deal.II/lac/linear_operator.h index f705e4997b..ecdc0fe3bb 100644 --- a/include/deal.II/lac/linear_operator.h +++ b/include/deal.II/lac/linear_operator.h @@ -57,7 +57,7 @@ null_operator(const LinearOperator &); * * The class essentially consists of std::function objects * that store the knowledge of how to apply the linear operator by - * implementing the abstract @ref Matrix interface: + * implementing the abstract @p Matrix interface: * @code * std::function vmult; * std::function vmult_add; @@ -576,7 +576,8 @@ operator*(const LinearOperator &first_op, /** * @relates LinearOperator * - * Returns the transpose linear operations of @ref op. + * Returns the transpose linear operations of + * @ref op. * * @ingroup LAOperators */ @@ -680,8 +681,9 @@ inverse_operator(const LinearOperatorstd::function object @ref - * reinit_vector as an argument to initialize the + * The function takes an std::function object + * @ref reinit_vector + * as an argument to initialize the * reinit_range_vector and reinit_domain_vector * objects of the LinearOperator object. * diff --git a/include/deal.II/lac/shifted_matrix.h b/include/deal.II/lac/shifted_matrix.h index 321ad9f461..54de67a637 100644 --- a/include/deal.II/lac/shifted_matrix.h +++ b/include/deal.II/lac/shifted_matrix.h @@ -33,8 +33,9 @@ DEAL_II_NAMESPACE_OPEN * with A+s I, where s is a provided shift parameter. * * @deprecated If deal.II was configured with C++11 support, use the - * LinearOperator class instead, see the module on @ref LAOperators "linear - * operators" for further details. + * LinearOperator class instead, see the module on + * @ref LAOperators "linear operators" + * for further details. * * @author Guido Kanschat, 2000, 2001 */ @@ -97,7 +98,8 @@ private: * * @deprecated If deal.II was configured with C++11 support, use the * LinearOperator class instead, see the module on - * @ref LAOperators "linear operators" for further details. + * @ref LAOperators "linear operators" + * for further details. * * @author Guido Kanschat, 2001 */ diff --git a/include/deal.II/numerics/vector_tools.h b/include/deal.II/numerics/vector_tools.h index 37b4a7c69e..3325d80644 100644 --- a/include/deal.II/numerics/vector_tools.h +++ b/include/deal.II/numerics/vector_tools.h @@ -1169,7 +1169,8 @@ namespace VectorTools * Dirichlet conditions should be set first, and then completed by hanging * node constraints, in order to make sure that the discretization remains * consistent. See the discussion on conflicting constraints in the - * module on @ref constraints + * module on + * @ref constraints. * *

Arguments to this function>

* @@ -1199,7 +1200,8 @@ namespace VectorTools * * @ingroup constraints * - * @see @ref GlossBoundaryIndicator "Glossary entry on boundary indicators" + * @see + * @ref GlossBoundaryIndicator "Glossary entry on boundary indicators" */ template void project_boundary_values_curl_conforming_l2 (const DoFHandler &dof_handler, -- 2.39.5