SDK/EntityList: Improve documentation

This commit is contained in:
Lynix 2017-05-11 19:46:57 +02:00
parent 48b348135e
commit 064ffd2945
2 changed files with 3 additions and 0 deletions

View File

@ -63,10 +63,13 @@ namespace Ndk
/*!
* \brief Inserts the entity into the set
*
* Marks an entity as present in this entity list, it must belongs to the same world as others entities contained in this list.
*
* \param entity Valid pointer to an entity
*
* \remark If entity is already contained, no action is performed
* \remark If any entity has been inserted since construction (or last Clear call), the entity must belong to the same world as the previously inserted entities
* \remark It's up to the programmer to remove an entity from this list before its deletion
*/
inline void EntityList::Insert(Entity* entity)
{