summaryrefslogtreecommitdiff
path: root/src/Bottleneck_distance/include/gudhi/Bottleneck.h
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-06-13 17:13:42 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-06-13 17:13:42 +0200
commita1088d88479e6c18c5ade73ffc34bba2bf37bc1d (patch)
tree14309e99a25093275b0a2be20d4c4786e7fad2a9 /src/Bottleneck_distance/include/gudhi/Bottleneck.h
parent08ddc6dbbbb1cf01a05ab23ece47c3d8cf9957ea (diff)
parentf9a2172f24da8d7538c67fbf4e7580ab09b456c5 (diff)
Merge master branch
Diffstat (limited to 'src/Bottleneck_distance/include/gudhi/Bottleneck.h')
-rw-r--r--src/Bottleneck_distance/include/gudhi/Bottleneck.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/Bottleneck_distance/include/gudhi/Bottleneck.h b/src/Bottleneck_distance/include/gudhi/Bottleneck.h
index c56dcb2d..105f1a93 100644
--- a/src/Bottleneck_distance/include/gudhi/Bottleneck.h
+++ b/src/Bottleneck_distance/include/gudhi/Bottleneck.h
@@ -8,6 +8,7 @@
*
* Modification(s):
* - YYYY/MM Author: Description of the modification
+ * - 2019/06 Vincent Rouvreau : Fix doxygen warning.
*/
#ifndef BOTTLENECK_H_
@@ -82,6 +83,10 @@ inline double bottleneck_distance_exact(Persistence_graph& g) {
*
* \tparam Persistence_diagram1,Persistence_diagram2
* models of the concept `PersistenceDiagram`.
+ *
+ * \param[in] diag1 The first persistence diagram.
+ * \param[in] diag2 The second persistence diagram.
+ *
* \param[in] e
* \parblock
* If `e` is 0, this uses an expensive algorithm to compute the exact distance.