[richfaces-svn-commits] JBoss Rich Faces SVN: r22238 - trunk/cdk/annotations/src/main/java/org/richfaces/cdk/annotations.

Author: alexsmirnov Date: 2011-03-16 00:01:07 -0400 (Wed, 16 Mar 2011) New Revision: 22238 Modified: trunk/cdk/annotations/src/main/java/org/richfaces/cdk/annotations/JsfComponent.java Log: CODING IN PROGRESS - issue RFPL-1347: Annotations Javadoc https://issues.jboss.org/browse/RFPL-1347 Modified: trunk/cdk/annotations/src/main/java/org/richfaces/cdk/annotations/JsfComponent.java =================================================================== --- trunk/cdk/annotations/src/main/java/org/richfaces/cdk/annotations/JsfComponent.java 2011-03-16 01:38:50 UTC (rev 22237) +++ trunk/cdk/annotations/src/main/java/org/richfaces/cdk/annotations/JsfComponent.java 2011-03-16 04:01:07 UTC (rev 22238) @@ -28,15 +28,18 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; +import javax.faces.component.UICommand; +import javax.faces.component.UIComponentBase; +import javax.faces.component.UIInput; +import javax.faces.component.html.HtmlCommandButton; +import javax.faces.component.html.HtmlCommandLink; import javax.faces.event.FacesEvent; /** * <p class="changed_added_4_0"> * That annotation marks class as JSF component. The difference with JSF 2.0 &#064; - * {@link javax.faces.component.FacesComponent} annotation is what this one could marks abstaract class from which a - * real UI-component implementation will be generated. The value of default {@link #type()} attribute is taken to be - * <em>component type</em>. The fully qualified class name becomes a component class unless that class is abstract or - * final component class is defined by the {@link #generate()} attribute value. + * {@link javax.faces.component.FacesComponent} annotation is what this one could marks abstract class from which a + * real UI-component implementation will be generated. * </p> * * @author asmirnov(a)exadel.com @@ -47,25 +50,18 @@ /** * <p class="changed_added_4_0"> - * Annotation class name to use as key for annotation processor class. + * Annotation class name to use as key in the annotation processor. * </p> */ public static final String NAME = "org.richfaces.cdk.annotations.JsfComponent"; - /** - * <p class="changed_added_4_0"> - * Excplicitly disable component generation - * </p> - */ - public static final String DISABLED = "##DISABLED"; /** * <p class="changed_added_4_0"> - * Type of the component. This is mandatory parameter because CDK uses <em>component-type</em> as primary key for - * components library model. + * Type of the JSF component. * </p> - * <p class="todo"> - * TODO if this value is an empty, component type will be inferred from class name. + * <p class="naming"> + * if this value is an empty, component type would be inferred from class name. * </p> * * @return component type. @@ -74,7 +70,7 @@ /** * <p class="changed_added_4_0"> - * Component famili. If this attribute was empty, it is inferred from the COMPONENT_FAMILY constant or by naming + * Component family. For default value, it is inferred from the COMPONENT_FAMILY constant or by naming * conventions. * </p> * @@ -93,7 +89,7 @@ /** * <p class="changed_added_4_0"> - * Description used by IDE. + * Component description to include into generated faces-config and taglib. * </p> * * @return @@ -102,7 +98,7 @@ /** * <p class="changed_added_4_0"> - * Cenerated Junit test. + * Junit test description. Isn't used in RichFaces 4.0, reserved for future releases. * </p> * * @return @@ -120,7 +116,7 @@ /** * <p class="changed_added_4_0"> - * View Description Language, JSP or Facelets, tags. + * Tag description, for JSP and Facelets, tags. * </p> * * @return @@ -129,7 +125,7 @@ /** * <p class="changed_added_4_0"> - * Events fired by the component. + * Faces Events fired by the component. * </p> * * @return @@ -147,9 +143,9 @@ /** * <p class="changed_added_4_0"> - * defines fragments of faces-config.xml that contain standard attribute definitions. CDK also tries to read - * META-INF/cdk/attributes/[classname].xml file for all component superclasses and interfaces, therefore it is not - * necessary to explicit include definitions for UIComponent and any other standard JSF classes. CDK defines couple + * Defines fragments of faces-config.xml that contain standard attribute definitions. CDK also tries to read + * META-INF/cdk/attributes/[classname].xml file for all component superclass's and interfaces. therefore it is not + * necessary to explicitly include definitions for UIComponent and any other standard JSF classes. CDK defines couple * of its own "urn" namespaces: "urn:resource:" for classpath resources, "urn:config:" for for project configuration * folder and "urn:attributes:" for META-INF/cdk/attributes/ in the annotations library. * </p> @@ -169,7 +165,9 @@ public Class<?>[] interfaces() default {}; /** - * <p class="changed_added_4_0"></p> + * <p class="changed_added_4_0">Defines third-level renderer-specific components. Used to generate a whole family of similar components. + * For example, {@link UIComponentBase} provides {@link UICommand} subclass for all command components, and {@link HtmlCommandLink} with {@link HtmlCommandButton} are + * renderer-specific components for links and buttons.</p> * @return */ public RendererSpecificComponent[] components() default {};