From: Simon Sticko <simon@sticko.se>
Date: Tue, 7 Apr 2020 19:02:25 +0000 (+0200)
Subject: Three small documentation fixes related to BoundingBox.
X-Git-Tag: v9.2.0-rc1~260^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=96c4e5d43b20741872742113c4ee59801235533f;p=dealii.git

Three small documentation fixes related to BoundingBox.
---

diff --git a/include/deal.II/base/bounding_box.h b/include/deal.II/base/bounding_box.h
index 3333bd744f..6af0ec964f 100644
--- a/include/deal.II/base/bounding_box.h
+++ b/include/deal.II/base/bounding_box.h
@@ -237,7 +237,8 @@ public:
   bounds(const unsigned int direction) const;
 
   /**
-   * Returns the indexth vertex of the box.
+   * Returns the indexth vertex of the box. Vertex is meant in the same way as
+   * for a cell, so that @p index $\in [0, 2^{\text{dim}} - 1]$.
    */
   Point<spacedim, Number>
   vertex(const unsigned int index) const;
@@ -269,7 +270,9 @@ private:
 
 
 /**
- * Returns the unit box [0,1]^dim.
+ * Returns the unit box $[0,1]^\text{dim}$.
+ *
+ * @relates BoundingBox
  */
 template <int dim, typename Number = double>
 BoundingBox<dim, Number>
@@ -312,6 +315,8 @@ namespace internal
    * @param locked_coordinate should be in the range [0, dim+1).
    * @param coordiante_in_dim should be in the range [0, dim).
    * @return A coordinate index in the range [0, dim+1)
+   *
+   * @relates BoundingBox
    */
   template <int dim>
   inline unsigned int