songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

document setters and change wording of getters

This commit is contained in:
Andreas Fabri 2014-11-05 10:23:17 +01:00
parent 225b174b80
commit 4fc6d7953a
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Polyline_simplification_2/doc/Polyline_simplification_2/Concepts/PolylineSimplificationVertexBase_2.h
View File

@ -27,16 +27,20 @@ public:
/// \name Access Functions
/// @{
/*! The Boolean that indicates whether the vertex can be removed.
/*! indicates whether the vertex can be removed.
*/
bool is_removable() const;
/*! allows to set whether the vertex can be removed.
*/
void set_removable(bool b);
/*! The cost if the vertex got removed.
/*! returns the cost of the vertex removal.
*/
FT& cost();
FT cost() const;
/*! allows to set the cost of the vertex removal.
*/
void set_cost(const FT& ft);
/// @}