fix pmap doc

This commit is contained in:
Sébastien Loriot 2017-11-28 14:01:07 +01:00
parent ff9dc98390
commit 9c19e70db9
1 changed files with 3 additions and 3 deletions

View File

@ -456,14 +456,14 @@ struct Default_property_map{
get (const Default_property_map&, const key_type&){ return ValueType(); } get (const Default_property_map&, const key_type&){ return ValueType(); }
}; };
/// \ingroup PkgProperty_map
/// Read-write Property map turning a set (such a `std::set`, /// Read-write Property map turning a set (such a `std::set`,
/// `boost::unordered_set`, `std::unordered_set`) into a property map /// `boost::unordered_set`, `std::unordered_set`) into a property map
/// associating a Boolean to the value type of the set. The function `get` will /// associating a Boolean to the value type of the set. The function `get` will
/// return `true` if the key is inside the set and `false` otherwise. The `put` /// return `true` if the key is inside the set and `false` otherwise. The `put`
/// function will insert an element in the set if `true` is passed and erase it /// function will insert an element in the set if `true` is passed and erase it
/// otherwise. /// otherwise.
/// /// \cgalModels `ReadWritePropertyMap`
/// `operator()(key k)` calling the get function with `k`
template<class Set> template<class Set>
struct Boolean_property_map struct Boolean_property_map
{ {
@ -475,8 +475,8 @@ struct Boolean_property_map
Set* set_ptr; Set* set_ptr;
/// Constructor taking a copy of the set. Note that `set_` must be valid /// Constructor taking a copy of the set. Note that `set_` must be valid
/// while the property map is in use. /// while the property map is in use.
Boolean_property_map() : set_ptr(NULL) {}
Boolean_property_map(Set& set_) : set_ptr(&set_) {} Boolean_property_map(Set& set_) : set_ptr(&set_) {}
Boolean_property_map() : set_ptr(NULL) {}
friend bool get(const Boolean_property_map<Set>& pm, const key_type& k) friend bool get(const Boolean_property_map<Set>& pm, const key_type& k)
{ {