Browse Source

collide: Add docstring for CollisionTraverser::traverse()

rdb 5 years ago
parent
commit
3fe1d286d0
1 changed files with 4 additions and 1 deletions
  1. 4 1
      panda/src/collide/collisionTraverser.cxx

+ 4 - 1
panda/src/collide/collisionTraverser.cxx

@@ -248,7 +248,10 @@ clear_colliders() {
 }
 }
 
 
 /**
 /**
- *
+ * Perform the traversal. Begins at the indicated root and detects all
+ * collisions with any of its collider objects against nodes at or below the
+ * indicated root, calling the appropriate CollisionHandler for each detected
+ * collision.
  */
  */
 void CollisionTraverser::
 void CollisionTraverser::
 traverse(const NodePath &root) {
 traverse(const NodePath &root) {