Improve the Doxygen documentation for vector.h

git-svn-id: svn+ssh://svn.gna.org/svn/warzone/trunk@6424 4a71c877-e1ca-e34f-864e-861f7616d084
master
Freddie Witherden 2008-12-02 20:47:21 +00:00
parent f25687e130
commit 670ebcd4bb
1 changed files with 6 additions and 1 deletions

View File

@ -67,7 +67,12 @@ void *vectorAt(vector *v, int index);
void *vectorHead(vector *v);
/**
*
* Sets the item at offset index of the vector v to object.
*
* @param v The vector to set.
* @param index The index of the item to be set.
* @param object The item to set v[index] to.
* @return The current item at index.
*/
void *vectorSetAt(vector *v, int index, void *object);