]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix some minor doxygen issues. 7556/head
authorDavid Wells <wellsd2@rpi.edu>
Fri, 28 Dec 2018 21:23:14 +0000 (16:23 -0500)
committerDavid Wells <wellsd2@rpi.edu>
Fri, 28 Dec 2018 21:25:15 +0000 (16:25 -0500)
This commit adds missing text and improves some HTML.

include/deal.II/base/array_view.h
include/deal.II/grid/tria_iterator.h
include/deal.II/hp/dof_handler.h

index 91e5aa7ac3e5b370349a8d402ecd6178fe6705da..af535237e7b53b82713b843ce6dc991bfa6654cc 100644 (file)
@@ -789,7 +789,7 @@ make_array_view(const std::vector<ElementType> &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 <code>starting_index + size_of_view <= vector.size()</code>
  *
@@ -823,7 +823,7 @@ make_array_view(std::vector<ElementType> &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 <code>starting_index + size_of_view <= vector.size()</code>
  *
index 240aef0339a6018e4f5fc9908bcaabc670b3f1ab..b2af452fe60614f9d33fc2b1a62a40f0d12d7528 100644 (file)
@@ -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 <i
- * >before-the-start</i> value, when running backwards. There is no
+ * Past-the-end iterators may also be used to compare an iterator with the
+ * <i>before-the-start</i> 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
index 6560d5646fd897dd23a88eb0ccc9ea63326aeb9a..853bc361773963c8bf43f8a975a362081f16bd55 100644 (file)
@@ -529,10 +529,9 @@ namespace hp
      *
      * Range-based for loops are useful in that they require much less code
      * than traditional loops (see <a
-     * href="http://en.wikipedia.org/wiki/C%2B%2B11#Range-
-     * based_for_loop">here</a> 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</a>
+     * 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<dim> dof_handler;
      *   ...

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.