Added javadoc to getChild to explain that its really getDescendant

git-svn-id: https://jmonkeyengine.googlecode.com/svn/trunk@10498 75d07b2b-3a1a-0410-a2c5-0572b91ccdca
2013-03-22 22:49:23 +00:00 · 2013-03-22 22:49:23 +00:00 · 75d861eae1
commit 75d861eae1
parent 723e3c0e30
1 changed files with 3 additions and 1 deletions
--- a/engine/src/core/com/jme3/scene/Node.java
+++ b/engine/src/core/com/jme3/scene/Node.java
@ -418,7 +418,9 @@ public class Node extends Spatial implements Savable {

    /**
     * <code>getChild</code> returns the first child found with exactly the
-     * given name (case sensitive.)
+     * given name (case sensitive.) This method does a depth first recursive
+     * search of all descendants of this node, it will return the first node
+     * found with a matching name.
     * 
     * @param name
     *            the name of the child to retrieve. If null, we'll return null.