Updated documentation.

This commit is contained in:
Felix Ableitner 2012-10-13 19:28:46 +02:00
parent c1c461f8e2
commit f0753b4a3a
1 changed files with 2 additions and 1 deletions

View File

@ -295,10 +295,11 @@ Pathfinder::Pathfinder(b2World& world) :
*
* The path returned is in reverse order so that the immediate next point to move to can be
* accessed via pop_back().
* Returns an empty vector on failure.
*
* @param physical The object to be moved.
* @param to The position to find a path to.
* @return The path from physical.getPostion() to destination.
* @return The path from physical.getPostion() to destination. Empty on failure.
*
* TODO: Objects are only recognized partially, examples:
* Mostly ignores Cover.