]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Three small documentation fixes related to BoundingBox. 9852/head
authorSimon Sticko <simon@sticko.se>
Tue, 7 Apr 2020 19:02:25 +0000 (21:02 +0200)
committerSimon Sticko <simon@sticko.se>
Wed, 8 Apr 2020 12:38:59 +0000 (14:38 +0200)
include/deal.II/base/bounding_box.h

index 3333bd744f8062b82e916a53e55480153e96b95f..6af0ec964faa09d39217f2489f7e8d07fccd21aa 100644 (file)
@@ -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

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.