svn commit: r930878 - /wicket/trunk/wicket/src/main/java/org/apache/wicket/Component.java

[iv...@apache.org]

Author: ivaynberg
Date: Mon Apr  5 15:20:21 2010
New Revision: 930878

URL: http://svn.apache.org/viewvc?rev=930878&view=rev
Log:
javadoc tweak

Modified:
    wicket/trunk/wicket/src/main/java/org/apache/wicket/Component.java

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/Component.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/Component.java?rev=930878&r1=930877&r2=930878&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/Component.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/Component.java Mon Apr  5 15:20:21 2010
@@ -857,14 +857,15 @@ public abstract class Component implemen
 	}
 
 	/**
-	 * Callback method invoked after the component was added to its parent AND you can walk up the
-	 * hierarchy up until the Page. That is, all parents must be have been added to their parents as
-	 * well. Add this point in time {@link #getMarkup() getMarkup} is guaranteed to be available.
-	 * <p>
-	 * This method is guaranteed to called only once
-	 * </p>
+	 * This method is meant to be used as an alternative to initialize components. Usually the
+	 * component's constructor is used for this task, but sometimes a component cannot be
+	 * initialized in isolation, it may need to access its parent component or its markup in order
+	 * to fully initialize. This method is invoked once per component's lifecycle when a path exists
+	 * from this component to the {@link Page} thus providing the component with an atomic callback
+	 * when the component's environment is built out.
+	 * 
 	 * <p>
-	 * If you don't like constructors to initialize your component, this is the method to use.
+	 * It is safe to use {@link #getPage()} and {@link #getMarkup()} in this method
 	 * </p>
 	 */
 	protected void onInitialize()