Browse Source

pgraph: Clarify in find() documentation that this node not included

rdb 4 years ago
parent
commit
2cc1633a77
1 changed files with 4 additions and 0 deletions
  1. 4 0
      panda/src/pgraph/nodePath.cxx

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

@@ -309,6 +309,8 @@ get_sort(Thread *current_thread) const {
  * Searches for a node below the referenced node that matches the indicated
  * Searches for a node below the referenced node that matches the indicated
  * string.  Returns the shortest match found, if any, or an empty NodePath if
  * string.  Returns the shortest match found, if any, or an empty NodePath if
  * no match can be found.
  * no match can be found.
+ *
+ * The referenced node itself is not considered in the search.
  */
  */
 NodePath NodePath::
 NodePath NodePath::
 find(const string &path) const {
 find(const string &path) const {
@@ -349,6 +351,8 @@ find_path_to(PandaNode *node) const {
 /**
 /**
  * Returns the complete set of all NodePaths that begin with this NodePath and
  * Returns the complete set of all NodePaths that begin with this NodePath and
  * can be extended by path.  The shortest paths will be listed first.
  * can be extended by path.  The shortest paths will be listed first.
+ *
+ * The referenced node itself is not considered in the search.
  */
  */
 NodePathCollection NodePath::
 NodePathCollection NodePath::
 find_all_matches(const string &path) const {
 find_all_matches(const string &path) const {