From 805e521671182255aef825e0fd325653815b925d Mon Sep 17 00:00:00 2001 From: David Wells Date: Fri, 28 Dec 2018 16:23:14 -0500 Subject: [PATCH] Fix some minor doxygen issues. This commit adds missing text and improves some HTML. --- include/deal.II/base/array_view.h | 4 ++-- include/deal.II/grid/tria_iterator.h | 4 ++-- include/deal.II/hp/dof_handler.h | 7 +++---- 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/include/deal.II/base/array_view.h b/include/deal.II/base/array_view.h index 91e5aa7ac3..af535237e7 100644 --- a/include/deal.II/base/array_view.h +++ b/include/deal.II/base/array_view.h @@ -789,7 +789,7 @@ make_array_view(const std::vector &vector) * object. * @param[in] starting_index The index of the first element of the vector that * will be part of this view. - * @param[in] size_of_view + * @param[in] size_of_view Number of elements in the new ArrayView. * * @pre starting_index + size_of_view <= vector.size() * @@ -823,7 +823,7 @@ make_array_view(std::vector &vector, * object. * @param[in] starting_index The index of the first element of the vector that * will be part of this view. - * @param[in] size_of_view + * @param[in] size_of_view Number of elements in the new ArrayView. * * @pre starting_index + size_of_view <= vector.size() * diff --git a/include/deal.II/grid/tria_iterator.h b/include/deal.II/grid/tria_iterator.h index 240aef0339..b2af452fe6 100644 --- a/include/deal.II/grid/tria_iterator.h +++ b/include/deal.II/grid/tria_iterator.h @@ -208,8 +208,8 @@ class TriaActiveIterator; * iterator is invalid anyway, regardless of the state of the triangulation * pointer and the state of the element pointed to. * - * Past-the-end iterators may also be used to compare an iterator with the before-the-start value, when running backwards. There is no + * Past-the-end iterators may also be used to compare an iterator with the + * before-the-start value, when running backwards. There is no * distinction between the iterators pointing past the two ends of a vector. * * By defining only one value to be past-the-end and making all other values diff --git a/include/deal.II/hp/dof_handler.h b/include/deal.II/hp/dof_handler.h index 6560d5646f..853bc36177 100644 --- a/include/deal.II/hp/dof_handler.h +++ b/include/deal.II/hp/dof_handler.h @@ -529,10 +529,9 @@ namespace hp * * Range-based for loops are useful in that they require much less code * than traditional loops (see here for a discussion of how they work). An example - * is that without range-based for loops, one often writes code such as - * the following: + * href="http://en.wikipedia.org/wiki/C%2B%2B11#Range-based_for_loop">here + * for a discussion of how they work). An example is that without + * range-based for loops, one often writes code such as the following: * @code * DoFHandler dof_handler; * ... -- 2.39.5