Add some documentation to help understand what happens in the code

dune/subgrid/subgrid/subgridindexstorage.hh

@@ -241,7 +241,6 @@ class SubGridIndexStorageBase
         }
 
 
-
         const GridType& grid;
         const HostGridType& hostgrid;
 
@@ -798,19 +797,19 @@ class LeafOnLevelCounter
         }
 
 
-        //! \todo Please doc me !
+        //! Total number of leaf entities
         int leafCount;
 
-        //! \todo Please doc me !
+        //! Number of copied leaf entities
         int copyLeafCount;
 
-        //! \todo Please doc me !
+        //! Number of leaf entities that are no copy of coarser level entities
         int newLeafCount;
 
-        //! \todo Please doc me !
+        //! Leaf index of first leaf entity that is not a copy on that level
         int newLeafIndexStart;
 
-        //! \todo Please doc me !
+        //! The shift that is used to compute leaf indices of new leaf entities from the level index of the leaf entity
         int newLeafOffset;
 };
 
@@ -977,7 +976,7 @@ class SubGridVectorIndexStorage :
         using HostIdSet = typename Base::HostIdSet;
         using HostIdType = typename Base::HostIdType;
 
-        //! \todo Please doc me !
+        //! For all possible geometry types of a grid dimension, store an index for each entity in the host grid
         typedef typename std::vector<std::vector<int> > EntityToIndex;
 
         //! \todo Please doc me !
@@ -1007,9 +1006,7 @@ class SubGridVectorIndexStorage :
             return (index>-3);
         }
 
-
-
-        //! \todo Please doc me !
+        //! Setup the index storage
         void update()
         {
             numEntities.clear();
@@ -1223,7 +1220,6 @@ class SubGridVectorIndexStorage :
             return;
         }
 
-
     private:
 
         // this should only be called by update
@@ -1267,10 +1263,10 @@ class SubGridVectorIndexStorage :
         //! Value to mark entities in the levelIndices vector which are leaf
         int hasLeafIndexValue{-1};
 
-        //! \todo Please doc me !
+        //! For each level and each Geometry type this contains information about new leaf entities and copies of coarser ones
         std::vector< std::vector<LeafOnLevelCounter> > leafInfo;
 
-        //! \todo Please doc me !
+        //! Contains leaf indices of leaf entities that are copies
         MultilevelEntityToIndex leafIndices;
 
         //! \todo Please doc me !