Documentation changes (mainly to document allocation strategies)

git-svn-id: svn://svn.code.sf.net/p/irrlicht/code/trunk@5465 dfc29bdd-3216-0410-991c-e03cc46cb475
master
cutealien 2017-06-01 22:43:47 +00:00
parent 9cbbdeafb3
commit 49b59e39b1
2 changed files with 5 additions and 7 deletions

View File

@ -108,12 +108,12 @@ public:
#define DEBUG_CLIENTBLOCK new( _CLIENT_BLOCK, __FILE__, __LINE__)
#endif
//! defines an allocation strategy
//! defines an allocation strategy (used only by irr::array so far)
enum eAllocStrategy
{
ALLOC_STRATEGY_SAFE = 0,
ALLOC_STRATEGY_DOUBLE = 1,
ALLOC_STRATEGY_SQRT = 2
ALLOC_STRATEGY_SAFE = 0, // increase size by 1
ALLOC_STRATEGY_DOUBLE = 1, // increase at least 6, double size when under 500 elements, otherwise increase by 1/4th of number elements
ALLOC_STRATEGY_SQRT = 2 // not implemented
};

View File

@ -126,9 +126,7 @@ public:
//! Insert item into array at specified position.
/** Please use this only if you know what you are doing (possible
performance loss). The preferred method of adding elements should be
push_back().
/**
\param element: Element to be inserted
\param index: Where position to insert the new element. */
void insert(const T& element, u32 index=0)