summaryrefslogtreecommitdiff
path: root/src/Alpha_complex/include/gudhi
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-03-17 13:44:28 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-03-17 13:44:28 +0000
commit26e05a189a31846cd1aa97e055ff3595d9dddca1 (patch)
tree61111a72ee5037a2eebd2e990671f04d9ef6b482 /src/Alpha_complex/include/gudhi
parentfa4810bea8d480f09d4cba5beba51805522cfdfe (diff)
Use post and exception doxygen tag instead of warnings everywhere.
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/alphashapes@1053 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 5e263835e662d66ef068c73d3efe71f72f90de10
Diffstat (limited to 'src/Alpha_complex/include/gudhi')
-rw-r--r--src/Alpha_complex/include/gudhi/Alpha_complex.h5
1 files changed, 2 insertions, 3 deletions
diff --git a/src/Alpha_complex/include/gudhi/Alpha_complex.h b/src/Alpha_complex/include/gudhi/Alpha_complex.h
index 415aa032..2d2d77a5 100644
--- a/src/Alpha_complex/include/gudhi/Alpha_complex.h
+++ b/src/Alpha_complex/include/gudhi/Alpha_complex.h
@@ -150,8 +150,7 @@ class Alpha_complex : public Simplex_tree<> {
*
* The type InputPointRange must be a range for which std::begin and
* std::end return input iterators on a Kernel::Point_d.
- * \warning In debug mode, the exception std::invalid_argument is thrown if an empty input point range is passed as
- * argument.
+ * \exception std::invalid_argument In debug mode, if an empty input point range is passed as argument.
*/
template<typename InputPointRange >
Alpha_complex(const InputPointRange& points,
@@ -191,7 +190,7 @@ class Alpha_complex : public Simplex_tree<> {
*
* @param[in] vertex Vertex handle of the point to retrieve.
* @return The point found.
- * @warning Exception std::out_of_range is thrown in case vertex is not found.
+ * @exception std::out_of_range In case vertex is not found (cf. std::vector::at).
*/
Point_d get_point(Vertex_handle vertex) const {
return vertex_handle_to_iterator_.at(vertex)->point();