From d10934da5dc35d1f8cf9a9ee1eeb724a12056676 Mon Sep 17 00:00:00 2001 From: Reza Rastak Date: Mon, 26 Aug 2019 18:14:09 -0700 Subject: [PATCH] representation of the decrement operator fixed in doxygen --- include/deal.II/base/vectorization.h | 4 ++-- include/deal.II/dofs/dof_handler.h | 2 +- include/deal.II/grid/filtered_iterator.h | 2 +- include/deal.II/grid/tria_iterator.h | 16 ++++++++-------- include/deal.II/lac/petsc_precondition.h | 4 ++-- include/deal.II/particles/particle_iterator.h | 4 ++-- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/include/deal.II/base/vectorization.h b/include/deal.II/base/vectorization.h index 012faf2019..b356e9c6b7 100644 --- a/include/deal.II/base/vectorization.h +++ b/include/deal.II/base/vectorization.h @@ -104,8 +104,8 @@ struct EnableIfScalar> * respectively (this corresponds to the SSE/SSE2 data sets) when compiling * deal.II on 64-bit operating systems. On Intel Sandy Bridge processors and * newer or AMD Bulldozer processors and newer, four doubles or eight floats - * are used when deal.II is configured using gcc with --with-cpu=native - * or --with-cpu=corei7-avx. On compilations with AVX-512 support (e.g., + * are used when deal.II is configured using gcc with \--with-cpu=native + * or \--with-cpu=corei7-avx. On compilations with AVX-512 support (e.g., * Intel Skylake Server from 2017), eight doubles or sixteen floats are used. * * This behavior of this class is made similar to the basic data types double diff --git a/include/deal.II/dofs/dof_handler.h b/include/deal.II/dofs/dof_handler.h index de66e8d9b4..d456be13f9 100644 --- a/include/deal.II/dofs/dof_handler.h +++ b/include/deal.II/dofs/dof_handler.h @@ -107,7 +107,7 @@ namespace internal * triangulation data. These iterators are built on top of those of the * Triangulation class, but offer the additional information on degrees of * freedom functionality compared to pure triangulation iterators. The order - * in which dof iterators are presented by the ++ and -- + * in which dof iterators are presented by the ++ and \-- * operators is the same as that for the corresponding iterators traversing * the triangulation on which this DoFHandler is constructed. * diff --git a/include/deal.II/grid/filtered_iterator.h b/include/deal.II/grid/filtered_iterator.h index fb0611a8d0..14d0aa54e1 100644 --- a/include/deal.II/grid/filtered_iterator.h +++ b/include/deal.II/grid/filtered_iterator.h @@ -341,7 +341,7 @@ namespace IteratorFilters * filter (called a predicate, following the notation of the C++ * standard library). Once initialized with a predicate and a value for the * iterator, a filtered iterator hops to the next or previous element that - * satisfies the predicate if operators ++ or -- are invoked. Intermediate + * satisfies the predicate if operators ++ or \-- are invoked. Intermediate * iterator values that lie in between but do not satisfy the predicate are * skipped. It is thus very simple to write loops over a certain class of * objects without the need to explicitly write down the condition they have diff --git a/include/deal.II/grid/tria_iterator.h b/include/deal.II/grid/tria_iterator.h index 094d125e69..88737bd62a 100644 --- a/include/deal.II/grid/tria_iterator.h +++ b/include/deal.II/grid/tria_iterator.h @@ -114,7 +114,7 @@ class TriaActiveIterator; * anyway. Most iterator and accessor functions are inlined. * * The main functionality of iterators, resides in the ++ and - * -- operators. These move the iterator forward or backward just as + * \-- operators. These move the iterator forward or backward just as * if it were a pointer into an array. Here, this operation is not so easy, * since it may include skipping some elements and the transition between the * triangulation levels. This is completely hidden from the user, though you @@ -151,7 +151,7 @@ class TriaActiveIterator; * member function bool used(), for the latter a member function * bool active(). * - *
  • It must have void operators ++ and --. + *
  • It must have void operators ++ and \--. * *
  • It must declare a local alias AccessorData which states the * data type the accessor expects to get passed as fourth constructor @@ -450,14 +450,14 @@ public: operator++(int); /** - * Prefix @p -- operator: @p --iterator. This operator moves the iterator to + * Prefix @p \-- operator: @p \--iterator. This operator moves the iterator to * the previous element and returns a reference to *this. */ TriaRawIterator & operator--(); /** - * Postfix @p -- operator: @p iterator--. This operator moves the iterator + * Postfix @p \-- operator: @p iterator\--. This operator moves the iterator * to the previous element, but returns an iterator to the element * previously pointed to. * @@ -714,14 +714,14 @@ public: operator++(int); /** - * Prefix @p -- operator: @p --i. This operator advances the iterator to the + * Prefix @p \-- operator: @p \--i. This operator advances the iterator to the * previous used element and returns a reference to *this. */ TriaIterator & operator--(); /** - * Postfix @p -- operator: @p i--. + * Postfix @p \-- operator: @p i\--. */ TriaIterator operator--(int); @@ -915,14 +915,14 @@ public: operator++(int); /** - * Prefix @p -- operator: @p --i. This operator advances the iterator to the + * Prefix @p \-- operator: @p \--i. This operator advances the iterator to the * previous active element and returns a reference to *this. */ TriaActiveIterator & operator--(); /** - * Postfix @p -- operator: @p i--. + * Postfix @p \-- operator: @p i\--. */ TriaActiveIterator operator--(int); diff --git a/include/deal.II/lac/petsc_precondition.h b/include/deal.II/lac/petsc_precondition.h index 59506055c0..fef5eaaddd 100644 --- a/include/deal.II/lac/petsc_precondition.h +++ b/include/deal.II/lac/petsc_precondition.h @@ -669,7 +669,7 @@ namespace PETScWrappers /** * A class that implements the interface to use the BoomerAMG algebraic * multigrid preconditioner from the HYPRE suite. Note that PETSc has to be - * configured with HYPRE (e.g. with --download-hypre=1). + * configured with HYPRE (e.g. with \--download-hypre=1). * * The preconditioner does support parallel distributed computations. See * step-40 for an example. @@ -791,7 +791,7 @@ namespace PETScWrappers /** * A class that implements the interface to use the ParaSails sparse * approximate inverse preconditioner from the HYPRE suite. Note that PETSc - * has to be configured with HYPRE (e.g. with --download-hypre=1). + * has to be configured with HYPRE (e.g. with \--download-hypre=1). * * ParaSails uses least-squares minimization to compute a sparse approximate * inverse. The sparsity pattern used is the pattern of a power of a diff --git a/include/deal.II/particles/particle_iterator.h b/include/deal.II/particles/particle_iterator.h index b2f7f8e94c..2384f2503c 100644 --- a/include/deal.II/particles/particle_iterator.h +++ b/include/deal.II/particles/particle_iterator.h @@ -107,7 +107,7 @@ namespace Particles operator++(int); /** - * Prefix -- operator: --iterator. This operator moves + * Prefix \-- operator: \--iterator. This operator moves * the iterator to the previous element and returns a reference to * *this. */ @@ -115,7 +115,7 @@ namespace Particles operator--(); /** - * Postfix -- operator: iterator--. This operator moves + * Postfix \-- operator: iterator\--. This operator moves * the iterator to the previous element, but returns an iterator to the * element previously pointed to. */ -- 2.39.5