christoph/fail
1
Fork 0
Code Actions Packages Releases Activity

Added missing doxygen comments.

Browse Source 
git-svn-id: https://www4.informatik.uni-erlangen.de/i4svn/danceos/trunk/devel/fail@1419 8c4709b5-6ec9-48aa-a5cd-a96041d1645a
This commit is contained in:
adrian
2012-07-04 08:29:20 +00:00
parent 4e2e02e48c
commit 8d8a472569
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/core/sal/EventManager.hpp
View File

@ -93,8 +93,9 @@ public:
*/ */
void remove(BaseEvent* ev); void remove(BaseEvent* ev);
/** /**
* Behaves like remove(BaseEvent) and additionally updates the provided * Behaves like remove(BaseEvent*) and additionally updates the provided
* iteration. * iterator.
* @param it the iterator pointing to the Event object to be removed
* @return the updated iterator which will point to the next element * @return the updated iterator which will point to the next element
*/ */
iterator remove(iterator it); iterator remove(iterator it);
@ -102,6 +103,9 @@ private:
/** /**
* Internal implementation of remove(iterator it) that allows * Internal implementation of remove(iterator it) that allows
* to skip the delete-list. * to skip the delete-list.
* @param it the iterator pointing to the Event object to be removed
* @param skip_deletelist \c true to skip the deletion of the Event object
* or \false to behave like \c remove(iterator)
* @return the updated iterator which will point to the next element * @return the updated iterator which will point to the next element
*/ */
iterator m_remove(iterator it, bool skip_deletelist); iterator m_remove(iterator it, bool skip_deletelist);
@ -115,6 +119,7 @@ public:
* [X|1|2| ... |n] * [X|1|2| ... |n]
* ^ * ^
* \endcode * \endcode
* @return iterator to the beginning
*/ */
iterator begin() { return (m_BufferList.begin()); } iterator begin() { return (m_BufferList.begin()); }
/** /**
@ -126,6 +131,7 @@ public:
* [1|2| ... |n]X * [1|2| ... |n]X
* ^ * ^
* \endcode * \endcode
* @return iterator to the end
*/ */
iterator end() { return (m_BufferList.end()); } iterator end() { return (m_BufferList.end()); }
/** /**