summaryrefslogtreecommitdiff
path: root/src/Bottleneck_distance/include/gudhi/Bottleneck.h
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-06-28 09:54:59 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-06-28 09:54:59 +0200
commitc7fcb08c78428913d848496da30eb713e85cc281 (patch)
tree05226fe9ac0b829253f2696c24776c411f000058 /src/Bottleneck_distance/include/gudhi/Bottleneck.h
parent8014a88ab31bc2c0278824a3da65ba7ca17fdce9 (diff)
parent695655d5cb347d809733a5fa1c0458fb98fd3272 (diff)
Merge branch 'master' into simplex_tree_insert_duplicated_vertices_fix_vincent
Diffstat (limited to 'src/Bottleneck_distance/include/gudhi/Bottleneck.h')
-rw-r--r--src/Bottleneck_distance/include/gudhi/Bottleneck.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/Bottleneck_distance/include/gudhi/Bottleneck.h b/src/Bottleneck_distance/include/gudhi/Bottleneck.h
index 7a553006..4ce6cacc 100644
--- a/src/Bottleneck_distance/include/gudhi/Bottleneck.h
+++ b/src/Bottleneck_distance/include/gudhi/Bottleneck.h
@@ -6,6 +6,9 @@
*
* Copyright (C) 2015 Inria
*
+ * Modifications:
+ * - 2019/06 Vincent Rouvreau : Fix doxygen warning.
+ *
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
@@ -92,6 +95,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.