From bc4c1262fd52922235f804f6413ebfba96eee968 Mon Sep 17 00:00:00 2001 From: bangerth Date: Fri, 27 Apr 2012 09:19:06 +0000 Subject: [PATCH] Avoid a number of doxygen markup warnings. git-svn-id: https://svn.dealii.org/trunk@25460 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/include/deal.II/algorithms/newton.h | 2 +- deal.II/include/deal.II/algorithms/operator.h | 5 ++-- .../deal.II/algorithms/timestep_control.h | 4 ++-- deal.II/include/deal.II/base/flow_function.h | 4 ++-- deal.II/include/deal.II/base/logstream.h | 4 ++-- deal.II/include/deal.II/base/subscriptor.h | 2 +- deal.II/include/deal.II/fe/fe_dg_vector.h | 2 +- deal.II/include/deal.II/fe/mapping.h | 24 +++++++++---------- deal.II/include/deal.II/lac/parallel_vector.h | 4 ++-- .../deal.II/lac/precondition_block_base.h | 12 +++++----- deal.II/include/deal.II/meshworker/dof_info.h | 12 +++++----- .../include/deal.II/meshworker/functional.h | 8 +++---- deal.II/include/deal.II/meshworker/output.h | 6 ++--- deal.II/include/deal.II/multigrid/mg_coarse.h | 20 ++++++++-------- .../include/deal.II/multigrid/mg_smoother.h | 6 ++--- 15 files changed, 58 insertions(+), 57 deletions(-) diff --git a/deal.II/include/deal.II/algorithms/newton.h b/deal.II/include/deal.II/algorithms/newton.h index 7bd649cad1..f3cdcee24b 100644 --- a/deal.II/include/deal.II/algorithms/newton.h +++ b/deal.II/include/deal.II/algorithms/newton.h @@ -190,7 +190,7 @@ namespace Algorithms bool debug_vectors; /** * Write debug output to - * #deallog; the higher the + * @p deallog; the higher the * number, the more output. */ unsigned int debug; diff --git a/deal.II/include/deal.II/algorithms/operator.h b/deal.II/include/deal.II/algorithms/operator.h index 0a58d365f8..ca9b9ca98a 100644 --- a/deal.II/include/deal.II/algorithms/operator.h +++ b/deal.II/include/deal.II/algorithms/operator.h @@ -103,12 +103,13 @@ namespace Algorithms * Empty virtual destructor. */ virtual ~OutputOperator(); + /** - * Set the stream #os to + * Set the stream @p os to * which data is written. If * no stream is selected with * this function, data goes - * to #deallog. + * to @p deallog. */ void initialize_stream(std::ostream& stream); /** diff --git a/deal.II/include/deal.II/algorithms/timestep_control.h b/deal.II/include/deal.II/algorithms/timestep_control.h index 12ddde717b..2c7f3ea94b 100644 --- a/deal.II/include/deal.II/algorithms/timestep_control.h +++ b/deal.II/include/deal.II/algorithms/timestep_control.h @@ -42,7 +42,7 @@ namespace Algorithms *
  • The resulting step size is used from the current time. * * - * The variable #print_step can be used to control the amount of + * The variable @p print_step can be used to control the amount of * output generated by the timestepping scheme. */ class TimestepControl : public Subscriptor @@ -201,7 +201,7 @@ namespace Algorithms /** * The size of the current time * step. This may differ from - * #step_val, if we aimed at #final_val. + * @p step_val, if we aimed at @p final_val. */ double current_step_val; double step_val; diff --git a/deal.II/include/deal.II/base/flow_function.h b/deal.II/include/deal.II/base/flow_function.h index cc1d5711f0..cbbb544ad1 100644 --- a/deal.II/include/deal.II/base/flow_function.h +++ b/deal.II/include/deal.II/base/flow_function.h @@ -147,8 +147,8 @@ namespace Functions /** * Laminar pipe flow in two and three dimensions. The channel - * stretches along the x-axis and has radius #radius. The - * #Reynolds number is used to scale the pressure properly for a + * stretches along the x-axis and has radius @p radius. The + * @p Reynolds number is used to scale the pressure properly for a * Navier-Stokes problem. * * @ingroup functions diff --git a/deal.II/include/deal.II/base/logstream.h b/deal.II/include/deal.II/base/logstream.h index 29714298e8..3ebbb2b834 100644 --- a/deal.II/include/deal.II/base/logstream.h +++ b/deal.II/include/deal.II/base/logstream.h @@ -95,7 +95,7 @@ class LogStream : public Subscriptor * a block, create one of these * objects, and it will appear as * a prefix in LogStream output - * like #deallog. At the end of + * like @p deallog. At the end of * the block, the prefix will * automatically be removed, when * this object is destroyed. @@ -105,7 +105,7 @@ class LogStream : public Subscriptor public: /** * Set a new prefix for - * #deallog, which will be + * @p deallog, which will be * removed when the variable * is destroyed . */ diff --git a/deal.II/include/deal.II/base/subscriptor.h b/deal.II/include/deal.II/base/subscriptor.h index 7fd27ab85f..3b3fecd6bb 100644 --- a/deal.II/include/deal.II/base/subscriptor.h +++ b/deal.II/include/deal.II/base/subscriptor.h @@ -115,7 +115,7 @@ class Subscriptor unsigned int n_subscriptions () const; /** - * List the subscribers to #deallog. + * List the subscribers to @p deallog. */ void list_subscribers () const; diff --git a/deal.II/include/deal.II/fe/fe_dg_vector.h b/deal.II/include/deal.II/fe/fe_dg_vector.h index 240cac9541..132f551ecf 100644 --- a/deal.II/include/deal.II/fe/fe_dg_vector.h +++ b/deal.II/include/deal.II/fe/fe_dg_vector.h @@ -114,7 +114,7 @@ class FE_DGVector * generalized_support_points * field of the FiniteElement * class and fill the tables with - * #interior_weights. Called + * @p interior_weights. Called * from the constructor. */ void initialize_support_points (const unsigned int degree); diff --git a/deal.II/include/deal.II/fe/mapping.h b/deal.II/include/deal.II/fe/mapping.h index 1294e8e190..f0e5c2931f 100644 --- a/deal.II/include/deal.II/fe/mapping.h +++ b/deal.II/include/deal.II/fe/mapping.h @@ -143,7 +143,7 @@ enum MappingType * reference cell, nothing needs to be done for them. For a function * defined on the computational domain, the quadrature points need to * be mapped, which is done in fill_fe_values() if - * #update_quadrature_points is set in the update flags. The mapped + * @p update_quadrature_points is set in the update flags. The mapped * quadrature points are then accessed through FEValuesBase::quadrature_point(). * * @todo Add a function transform_quadrature_points for this. @@ -159,7 +159,7 @@ enum MappingType * * The transformed quadrature weights $\left|\text{det}J(\mathbf{\hat * x})\right|$ are accessed through FEValuesBase::JxW() and - * computed in fill_fe_values(), if #update_JxW_values is set in the + * computed in fill_fe_values(), if @p update_JxW_values is set in the * update flags. * * @todo Add a function transform_quadrature_weights for @@ -430,12 +430,12 @@ class Mapping : public Subscriptor * * @note Normally, this function is called by a finite element, * filling FEValues objects. For this finite element, there should be - * an alias MappingType like #mapping_bdm, #mapping_nedelec, etc. This + * an alias MappingType like @p mapping_bdm, @p mapping_nedelec, etc. This * alias should be preferred to using the types below. * * The mapping types currently implemented by derived classes are: *