From 2a922a8b8456756ce1a6f702ee986893098a900b Mon Sep 17 00:00:00 2001
From: Jonathan Youett <youett@math.fu-berlin.de>
Date: Tue, 24 Oct 2017 15:35:55 +0200
Subject: [PATCH] Add some documentation

---
 dune/subgrid/subgrid/subgridintersection.hh | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/dune/subgrid/subgrid/subgridintersection.hh b/dune/subgrid/subgrid/subgridintersection.hh
index 03e3b28..179d05e 100644
--- a/dune/subgrid/subgrid/subgridintersection.hh
+++ b/dune/subgrid/subgrid/subgridintersection.hh
@@ -157,10 +157,13 @@ public:
 
         return *this;
     }
+
+    //! Return inside element
     Entity inside() const {
         return inside_;
     }
 
+    //! Return outside element, throws exception for boundary elements
     Entity outside() const {
         if (!neighbor())
             DUNE_THROW(GridError, "There is no neighbor!");
@@ -186,6 +189,7 @@ public:
                                                 : outsideIntersect_.indexInInside();
     }
 
+    //! Return GeometryType of the intersection
     GeometryType type () const {
         if (outside_.level() > inside_.level())
             return outsideIntersect_.type();
@@ -214,6 +218,7 @@ public:
             return insideIntersect_.centerUnitOuterNormal();
     }
 
+    //! Return the global geometry of the intersection
     Geometry geometry () const {
         if (outsideIntersect_.inside().level() >= insideIntersect_.inside().level())
             return Geometry(GeometryImpl(outsideIntersect_.geometry()));
-- 
GitLab