svn commit: r669651 - /myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIViewRoot.java

[sk...@apache.org]

Author: skitching
Date: Thu Jun 19 11:59:49 2008
New Revision: 669651

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

Modified:
    myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIViewRoot.java

Modified: myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIViewRoot.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIViewRoot.java?rev=669651&r1=669650&r2=669651&view=diff
==============================================================================
--- myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIViewRoot.java (original)
+++ myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIViewRoot.java Thu Jun 19 11:59:49 2008
@@ -41,7 +41,6 @@
 import javax.faces.webapp.FacesServlet;
 
 import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFComponent;
-import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFJspProperties;
 import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFJspProperty;
 import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFProperty;
 
@@ -446,10 +445,18 @@
   }
 
   /**
-   * Disable this property; although this class extends a base-class that
-   * defines a read/write id property, this particular subclass
-   * does not support setting it. Yes, this is broken OO design: direct
-   * all complaints to the JSF spec group.
+   * DO NOT USE.
+   * <p>
+   * Although this class extends a base-class that defines a read/write
+   * id property, it makes no sense for this particular subclass to support
+   * it. The tag library does not export this property for use, but there 
+   * is no way to "undeclare" a java method. Yes, this is broken OO design:
+   * direct all complaints to the JSF spec group.
+   * <p>
+   * This property should be disabled (ie throw an exception if invoked).
+   * However there are currently several places that call this method
+   * (eg during restoreState) so it just does the normal thing for the
+   * moment. TODO: fix callers then make this throw an exception.
    *
    * @JSFProperty tagExcluded="true"
    */