Browse Source

tweak comments

David Rose 21 years ago
parent
commit
1e10f59943
2 changed files with 11 additions and 7 deletions
  1. 11 4
      panda/src/pgraph/nodePath.cxx
  2. 0 3
      panda/src/pgraph/nodePath.h

+ 11 - 4
panda/src/pgraph/nodePath.cxx

@@ -75,6 +75,11 @@ get_num_nodes() const {
 //               referenced (bottom) node and get_num_nodes() - 1 is
 //               the top node.  This requires iterating through the
 //               path.
+//
+//               Also see node(), which is a convenience function to
+//               return the same thing as get_node(0) (since the
+//               bottom node is the most important node in the
+//               NodePath, and is the one most frequently referenced).
 ////////////////////////////////////////////////////////////////////
 PandaNode *NodePath::
 get_node(int index) const {
@@ -496,10 +501,12 @@ remove_node() {
 //       Access: Published
 //  Description: Disconnects the referenced node from its parent, but
 //               does not immediately delete it.  The NodePath retains
-//               a pointer to the node.  If there are no other
-//               instances to the node, this becomes a singleton
-//               NodePath; otherwise, this NodePath becomes the same
-//               as another arbitrary instance.
+//               a pointer to the node, and becomes a singleton
+//               NodePath.
+//
+//               This should be called to detach a node from the scene
+//               graph, with the option of reattaching it later to the
+//               same parent or to a different parent.
 //
 //               In practice, the only difference between
 //               remove_node() and detach_node() is that remove_node()

+ 0 - 3
panda/src/pgraph/nodePath.h

@@ -151,9 +151,6 @@ PUBLISHED:
     ET_not_found,  // returned from a failed find() or similar function.
     ET_removed,    // remove_node() was previously called on this NodePath.
     ET_fail,       // general failure return from some function.
-
-    // Also see NodePathComponent::_next_key, which initializes
-    // itself to the last enumerated type here plus one.
   };
 
   INLINE NodePath();