Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Some doc corrections

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53404 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robert Roebling
2008-04-28 18:13:11 +00:00
parent d095f867de
commit d38e30d1d2
1 changed files with 48 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
interface/list.h
View File

@@ -220,21 +220,25 @@ public:
void assign(size_type n); void assign(size_type n);
//@} //@}
//@{
/** /**
Returns the last item of the list. Returns the last item of the list.
*/ */
reference back() const; reference back() const;
const_reference back() const;
//@}
//@{
/** /**
Returns a (const) iterator pointing to the beginning of the list. Returns the last item of the list as a const reference.
*/
const_reference back() const;
/**
Returns an iterator pointing to the beginning of the list.
*/ */
iterator begin() const; iterator begin() const;
/**
Returns a const iterator pointing to the beginning of the list.
*/
const_iterator begin() const; const_iterator begin() const;
//@}
/** /**
Removes all items from the list. Removes all items from the list.
@@ -246,40 +250,52 @@ public:
*/ */
bool empty() const; bool empty() const;
//@{
/** /**
Returns a (const) iterator pointing at the end of the list. Returns a const iterator pointing at the end of the list.
*/
const_iterator end() const;
/**
Returns a iterator pointing at the end of the list.
*/ */
iterator end() const; iterator end() const;
const_iterator end() const;
//@}
//@{
/** /**
Erases the items from @a first to @e last. Erases the given item
*/ */
iterator erase(const iterator& it); iterator erase(const iterator& it);
/**
Erases the items from @e first to @e last.
*/
iterator erase(const iterator& first, iterator erase(const iterator& first,
const iterator& last); const iterator& last);
//@}
//@{
/** /**
Returns the first item in the list. Returns the first item in the list.
*/ */
reference front() const; reference front() const;
const_reference front() const;
//@}
//@{
/** /**
Inserts an item (or several) at the given position. Returns the first item in the list as a const reference.
*/
const_reference front() const;
/**
Inserts an item at the head of the list
*/ */
iterator insert(const iterator& it); iterator insert(const iterator& it);
/**
Inserts an item at the given position
*/
void insert(const iterator& it, size_type n); void insert(const iterator& it, size_type n);
/**
Inserts several items at the given position.
*/
void insert(const iterator& it, const_iterator first, void insert(const iterator& it, const_iterator first,
const const_iterator& last); const const_iterator& last);
//@}
/** /**
Returns the largest possible size of the list. Returns the largest possible size of the list.
@@ -297,42 +313,45 @@ public:
void pop_front(); void pop_front();
/** /**
)
Adds an item to end of the list. Adds an item to end of the list.
*/ */
void push_back(); void push_back();
/** /**
)
Adds an item to the front of the list. Adds an item to the front of the list.
*/ */
void push_front(); void push_front();
//@{
/** /**
Returns a (const) reverse iterator pointing to the beginning of the Returns a reverse iterator pointing to the beginning of the
reversed list. reversed list.
*/ */
reverse_iterator rbegin() const; reverse_iterator rbegin() const;
/**
Returns a const reverse iterator pointing to the beginning of the
reversed list.
*/
const_reverse_iterator rbegin() const; const_reverse_iterator rbegin() const;
//@}
/** /**
Removes an item from the list. Removes an item from the list.
*/ */
void remove(const_reference v); void remove(const_reference v);
//@{
/** /**
Returns a (const) reverse iterator pointing to the end of the Returns a reverse iterator pointing to the end of the
reversed list. reversed list.
*/ */
reverse_iterator rend() const; reverse_iterator rend() const;
const_reverse_iterator rend() const;
//@}
/** /**
) Returns a const reverse iterator pointing to the end of the
reversed list.
*/
const_reverse_iterator rend() const;
/**
Resizes the list. If the the list is enlarges items with Resizes the list. If the the list is enlarges items with
the value @e v are appended to the list. the value @e v are appended to the list.
*/ */