From: David Wells Date: Fri, 20 May 2016 20:17:54 +0000 (-0400) Subject: Fix doxygen formatting of hyphenated lists. X-Git-Tag: v8.5.0-rc1~1024^2~1 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=543d97f417c8715908d71985d00bdf8d0990b477;p=dealii.git Fix doxygen formatting of hyphenated lists. --- diff --git a/examples/step-22/step-22.cc b/examples/step-22/step-22.cc index b5adc57a5a..4f9910360e 100644 --- a/examples/step-22/step-22.cc +++ b/examples/step-22/step-22.cc @@ -595,16 +595,15 @@ namespace Step22 const FEValuesExtractors::Vector velocities (0); const FEValuesExtractors::Scalar pressure (dim); - // As an extension over step-20 and step-21, we include a few - // optimizations that make assembly much faster for this particular - // problem. The improvements are based on the observation that we do a - // few calculations too many times when we do as in step-20: The symmetric - // gradient actually has dofs_per_cell different values per - // quadrature point, but we extract it - // dofs_per_cell*dofs_per_cell times from the FEValues object - // - for both the loop over i and the inner loop over - // j. In 3d, that means evaluating it $89^2=7921$ instead of - // $89$ times, a not insignificant difference. + // As an extension over step-20 and step-21, we include a few optimizations + // that make assembly much faster for this particular problem. The + // improvements are based on the observation that we do a few calculations + // too many times when we do as in step-20: The symmetric gradient actually + // has dofs_per_cell different values per quadrature point, but + // we extract it dofs_per_cell*dofs_per_cell times from the + // FEValues object - for both the loop over i and the inner + // loop over j. In 3d, that means evaluating it $89^2=7921$ + // instead of $89$ times, a not insignificant difference. // // So what we're going to do here is to avoid such repeated calculations // by getting a vector of rank-2 tensors (and similarly for the divergence diff --git a/include/deal.II/base/parameter_handler.h b/include/deal.II/base/parameter_handler.h index c540812e7f..32dc6be868 100644 --- a/include/deal.II/base/parameter_handler.h +++ b/include/deal.II/base/parameter_handler.h @@ -1417,15 +1417,19 @@ namespace Patterns * We can think of the parameters so arranged as a file system in which every * parameter is a directory. The name of this directory is the name of the * parameter, and in this directory lie files that describe the parameter. - * These files are: - value: The content of this file is the - * current value of this parameter; initially, the content of the file equals - * the default value of the parameter. - default_value: The - * content of this file is the default value value of the parameter. - - * pattern: A textual representation of the pattern that - * describes the parameter's possible values. - pattern_index: A - * number that indexes the Patterns::PatternBase object that is used to - * describe the parameter. - documentation: The content of this - * file is the documentation given for a parameter as the last argument of the + * These files are: + * + * - value: The content of this file is the current value of this + * parameter; initially, the content of the file equals the default value of + * the parameter. + * - default_value: The content of this file is the default value + * value of the parameter. + * - pattern: A textual representation of the pattern that + * describes the parameter's possible values. + * - pattern_index: A number that indexes the Patterns::PatternBase + * object that is used to describe the parameter. + * - documentation: The content of this file is the documentation + * given for a parameter as the last argument of the * ParameterHandler::declare_entry call. With the exception of the * value file, the contents of files are never changed after * declaration of a parameter. diff --git a/include/deal.II/distributed/tria.h b/include/deal.II/distributed/tria.h index 3a12ebf34f..4f397b6094 100644 --- a/include/deal.II/distributed/tria.h +++ b/include/deal.II/distributed/tria.h @@ -699,10 +699,11 @@ namespace parallel * is * * - CELL_PERIST: the cell won't be refined/coarsened, but might be - * moved to a different processor - CELL_REFINE: this cell will be - * refined into 4/8 cells, you can not access the children (because they - * don't exist yet) - CELL_COARSEN: the children of this cell will be - * coarsened into the given cell (you can access the active children!) + * moved to a different processor + * - CELL_REFINE: this cell will be refined into 4/8 cells, you can not + * access the children (because they don't exist yet) + * - CELL_COARSEN: the children of this cell will be coarsened into the + * given cell (you can access the active children!) * * When unpacking the data with notify_ready_to_unpack() you can access * the children of the cell if the status is CELL_REFINE but not for diff --git a/include/deal.II/grid/tria.h b/include/deal.II/grid/tria.h index 7ecbe2acf9..7b9684280c 100644 --- a/include/deal.II/grid/tria.h +++ b/include/deal.II/grid/tria.h @@ -135,10 +135,11 @@ struct CellData types::manifold_id manifold_id; /** - * Default constructor. Sets the member variables to the following values: - - * vertex indices to invalid values - boundary or material id zero (the - * default for boundary or material ids) - manifold id to - * numbers::invalid_manifold_id + * Default constructor. Sets the member variables to the following values: + * + * - vertex indices to invalid values + * - boundary or material id zero (the default for boundary or material ids) + * - manifold id to numbers::invalid_manifold_id */ CellData (); }; diff --git a/include/deal.II/lac/solver.h b/include/deal.II/lac/solver.h index f0851e8b24..9e0b06a539 100644 --- a/include/deal.II/lac/solver.h +++ b/include/deal.II/lac/solver.h @@ -405,9 +405,11 @@ private: /** * A class whose operator() combines two states indicating whether we should * continue iterating or stop, and returns a state that dominates. The rules - * are: - If one of the two states indicates failure, return failure. - - * Otherwise, if one of the two states indicates to continue iterating, then - * continue iterating. - Otherwise, return success. + * are: + * - If one of the two states indicates failure, return failure. + * - Otherwise, if one of the two states indicates to continue iterating, then + * continue iterating. + * - Otherwise, return success. */ struct StateCombiner {