svn commit: r349578 - /myfaces/api/trunk/src/java/javax/faces/component/UIComponentBase.java

[sk...@apache.org]

Author: skitching
Date: Mon Nov 28 17:35:50 2005
New Revision: 349578

URL: http://svn.apache.org/viewcvs?rev=349578&view=rev
Log:
Javadoc tweaks

Modified:
    myfaces/api/trunk/src/java/javax/faces/component/UIComponentBase.java

Modified: myfaces/api/trunk/src/java/javax/faces/component/UIComponentBase.java
URL: http://svn.apache.org/viewcvs/myfaces/api/trunk/src/java/javax/faces/component/UIComponentBase.java?rev=349578&r1=349577&r2=349578&view=diff
==============================================================================
--- myfaces/api/trunk/src/java/javax/faces/component/UIComponentBase.java (original)
+++ myfaces/api/trunk/src/java/javax/faces/component/UIComponentBase.java Mon Nov 28 17:35:50 2005
@@ -338,10 +338,16 @@
 
     /**
      * Standard method for finding other components by id, inherited by
-     * most UIComponent objects. Note that although components have a
-     * strict parent/child hierarchy, component ids are only prefixed
-     * ("namespaced") with the id of their parent when the parent 
-     * is a NamingContainer.
+     * most UIComponent objects.
+     * <p>
+     * The lookup is performed in a manner similar to finding a file
+     * in a filesystem; there is a "base" at which to start, and the
+     * id can be for something in the "local directory", or can include
+     * a relative path. Here, NamingContainer components fill the role
+     * of directories, and ":" is the "path separator". Note, however,
+     * that although components have a strict parent/child hierarchy,
+     * component ids are only prefixed ("namespaced") with the id of
+     * their parent when the parent is a NamingContainer.
      * <p>
      * The base node at which the search starts is determined as
      * follows: