From: Wolfgang Bangerth <bangerth@colostate.edu>
Date: Mon, 3 Feb 2020 02:00:14 +0000 (-0700)
Subject: Update documentation of NeighborType.
X-Git-Tag: v9.2.0-rc1~579^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F9468%2Fhead;p=dealii.git

Update documentation of NeighborType.
---

diff --git a/include/deal.II/base/bounding_box.h b/include/deal.II/base/bounding_box.h
index ddf89fe67e..9dfc5302b7 100644
--- a/include/deal.II/base/bounding_box.h
+++ b/include/deal.II/base/bounding_box.h
@@ -32,25 +32,27 @@ DEAL_II_NAMESPACE_OPEN
 enum class NeighborType
 {
   /**
-   * not neighbours: the intersection is empty
+   * Not neighbors: the intersection is empty.
    */
   not_neighbors = 0,
 
   /**
-   * simple neighbors: the boxes intersect with an intersection of dimension at
-   * most spacedim - 2
+   * Simple neighbors: the boxes intersect with an intersection of dimension at
+   * most `spacedim - 2`. For example, in 2d this means that the two boxes
+   * touch at one corner of the each box.
    */
   simple_neighbors = 1,
 
   /**
-   * attached neighbors: neighbors with an intersection of dimension > spacedim
-   * - 2
+   * Attached neighbors: neighbors with an intersection of
+   * `dimension > spacedim - 2`. For example, in 2d this means that the two
+   * boxes touch along an edge.
    */
   attached_neighbors = 2,
 
   /**
-   * mergeable neighbors: neighbors which can be expressed with a single
-   * Bounding Box, e.g.
+   * Mergeable neighbors: neighbors which can be expressed with a single
+   * BoundingBox, e.g.
    *  @code
    *  .--V--W    .-----V
    *  |  |  | =  |     |