Merge pull request #1398 from rolanddenis/doc_Khalimsky

Enhancing KhalimskySpace related class documentations.
DGtal-team · Mar 5, 2019 · 091bbfe · 091bbfe
2 parents 877ef62 + 870f2a2
commit 091bbfe
Show file tree

Hide file tree

Showing 4 changed files with 603 additions and 386 deletions.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -41,6 +41,11 @@
 - *Geometry*
   - New LpMetric class (model of CMetricSpace) for distance computations in R^n.
     (David Coeurjolly,  [#1388](https://github.com/DGtal-team/DGtal/pull/1388))
+
+- *Documentation*
+  - Improving KhalimskySpace related classes documentations by displaying
+    a short description in the member list.
+    (Roland Denis,  [#1398](https://github.com/DGtal-team/DGtal/pull/1398))
 
 ## Bug Fixes
 

diff --git a/src/DGtal/topology/KhalimskyCellHashFunctions.h b/src/DGtal/topology/KhalimskyCellHashFunctions.h
@@ -46,7 +46,7 @@
 
 
 namespace std {
-  /**
+  /** @brief
    * Extend std namespace to define a std::hash function on
    * DGtal::KhalimskyCell.
    *
@@ -62,7 +62,7 @@ namespace std {
     }
   };
 
-  /**
+  /** @brief
    * Extend std namespace to define a std::hash function on
    * DGtal::SignedKhalimskyCell.
    *
@@ -83,7 +83,7 @@ namespace std {
 }
 
 namespace boost{
-  /**
+  /** @brief
    * Extend boost namespace to define a boost::hash function on
    * DGtal::KhalimskyCell.
    *
@@ -99,7 +99,7 @@ namespace boost{
     }
   };
 
-  /**
+  /** @brief
    * Extend boost namespace to define a boost::hash function on
    * DGtal::SignedKhalimskyCell.
    *