Document is_linked behaviour for slists with option linear<true>, as mentioned in Trac ticket #10328 ("is_linked is broken for linear slist")

This commit is contained in:
Ion Gaztañaga
2016-08-04 23:44:01 +02:00
parent 68c46450de
commit 5a7892a859

View File

@@ -270,6 +270,11 @@ class slist_member_hook
//! otherwise. This function can be used to test whether \c slist::iterator_to
//! will return a valid iterator.
//!
//! <b>Note</b>: If this member is called when the value is inserted in a
//! slist with the option linear<true>, this function will return "false"
//! for the last element, as it is not linked to anything (the next element is null),
//! so use with care.
//!
//! <b>Complexity</b>: Constant
bool is_linked() const;