Minor improvements to tld docs.

apache · Jan 13, 2008 · 3464b80 · 3464b80
1 parent 37580c7
commit 3464b80
Show file tree

Hide file tree

Showing 11 changed files with 119 additions and 40 deletions.
diff --git a/build/src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/UIColumn.xml b/build/src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/UIColumn.xml
@@ -25,7 +25,7 @@
         <!-- #################################################################################### -->
         <component-type>javax.faces.Column</component-type>
         <component-class>javax.faces.component.UIColumn</component-class>
-        <description></description>
+        <description>Base class for table columns</description>
 
         <component-extension>
             <mfp:component-supertype>javax.faces.ComponentBase</mfp:component-supertype>

diff --git a/...lugin/components/javax/faces/UIGrapic.xml → ...ugin/components/javax/faces/UIGraphic.xml b/...lugin/components/javax/faces/UIGrapic.xml → ...ugin/components/javax/faces/UIGraphic.xml
@@ -39,7 +39,16 @@
         </property>
 
         <property>
-            <description>The image URL</description>
+            <description><![CDATA[
+                <p>
+                The URL of the image. If the URL starts with a '/', it is relative
+                to the context path of the web application.
+                </p>
+                <p>
+                This attribute is an alias for the "value" property.
+                </p>
+                ]]>
+            </description>
             <property-name>url</property-name>
             <property-class>java.lang.String</property-class>
             <property-extension>

diff --git a/build/src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/UIInput.xml b/build/src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/UIInput.xml
@@ -51,7 +51,11 @@
             </property-extension>
         </property>
         <property>
-            <description>Validator Method, which should be invoked for validation.</description>
+            <description>
+              A method which is invoked during the validation phase for this component. It is
+              expected to check the submitted value for this component, and if not acceptable
+              then report a validation error for the component.
+            </description>
             <property-name>validator</property-name>
             <property-class>javax.faces.el.MethodBinding</property-class>
             <property-extension>
@@ -74,7 +78,12 @@
             </property-extension>
         </property>
         <property>
-            <description>A Method which is called when the value changed.</description>
+            <description>
+              A method which is invoked during postback processing for the current view if the
+              submitted value for this component is not equal to the value which the "value" expression
+              for this component returns. The phase in which this method is invoked can be controlled
+              via the immediate attribute.
+            </description>
             <property-name>valueChangeListener</property-name>
             <property-class>javax.faces.el.MethodBinding</property-class>
             <property-extension>

diff --git a/build/src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/UIMessage.xml b/build/src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/UIMessage.xml
@@ -31,7 +31,10 @@
 that display a single message on behalf of a component.</description>
 
         <property>
-            <description>The ID of the component the Message should be diplayed for.</description>
+            <description>
+              The ID of the component whose attached FacesMessage object (if present) should be
+              diplayed by this component.
+            </description>
             <property-name>for</property-name>
             <property-class>java.lang.String</property-class>
             <property-extension>
@@ -41,15 +44,19 @@ that display a single message on behalf of a component.</description>
 
         <!--showDetail-->
         <property>
-            <description>Indicates that details are shown.</description>
+            <description>
+              Specifies whether the detailed information from the message should be shown. Default to false.
+            </description>
             <property-name>showDetail</property-name>
             <property-class>boolean</property-class>
             <default-value>true</default-value>
         </property>
 
         <!--showSummary-->
         <property>
-            <description>Indicates that the summary should be included into the Message.</description>
+            <description>
+              Specifies whether the summary information from the message should be shown. Defaults to true.
+            </description>
             <property-name>showSummary</property-name>
             <property-class>boolean</property-class>
             <default-value>false</default-value>
@@ -61,4 +68,4 @@ that display a single message on behalf of a component.</description>
             <mfp:renderer-type>javax.faces.Message</mfp:renderer-type>
         </component-extension>
     </component>
-</faces-config>
+</faces-config>
diff --git a/build/src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/UIMessages.xml b/build/src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/UIMessages.xml
@@ -31,23 +31,31 @@
 that display a multiple messages on behalf of a component.</description>
 
         <property>
-            <description>Indicates that only global messages should be diplayed</description>
+            <description>
+              Specifies whether only messages (FacesMessage objects) not associated with a
+              specific component should be displayed, ie whether messages should be ignored
+              if they are attached to a particular component. Defaults to false.
+            </description>
             <property-name>globalOnly</property-name>
             <property-class>boolean</property-class>
             <default-value>false</default-value>
         </property>
 
         <!--showDetail-->
         <property>
-            <description>Indicates that details are shown.</description>
+            <description>
+              Specifies whether the detailed information from the message should be shown. Defaults to false.
+            </description>
             <property-name>showDetail</property-name>
             <property-class>boolean</property-class>
             <default-value>false</default-value>
         </property>
 
         <!--showSummary-->
         <property>
-            <description>Indicates that the summary should be included into the Message.</description>
+            <description>
+              Specifies whether the summary information from the message should be shown. Defaults to true.
+            </description>
             <property-name>showSummary</property-name>
             <property-class>boolean</property-class>
             <default-value>true</default-value>
@@ -58,4 +66,4 @@ that display a multiple messages on behalf of a component.</description>
             <mfp:renderer-type>javax.faces.Messages</mfp:renderer-type>
         </component-extension>
     </component>
-</faces-config>
+</faces-config>
diff --git a/build/src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/UIOutput.xml b/build/src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/UIOutput.xml
@@ -39,7 +39,14 @@
         </property>
 
         <property>
-            <description>An Instance ot the Converter</description>
+            <description><![CDATA[
+              An expression that specifies the Converter for this component. If
+              the expression is a static string or is a value expression which
+              returns a String, the String is used as an ID to look up a
+              registered Converter. If the value expression returns a Converter,
+              then that object is used.
+              ]]>
+            </description>
             <property-name>converter</property-name>
             <property-class>javax.faces.convert.Converter</property-class>
             <property-extension>
@@ -53,4 +60,4 @@
             <mfp:renderer-type>javax.faces.Text</mfp:renderer-type>
         </component-extension>
     </component>
-</faces-config>
+</faces-config>
diff --git a/...src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/html/HtmlColumn.xml b/...src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/html/HtmlColumn.xml
@@ -19,7 +19,22 @@
               xmlns:h="http://java.sun.com/jsf/html"
               xmlns:xi="http://www.w3.org/2001/XInclude">
     <component>
-        <description>Renders a UIComponent that represents a single column of data within a parent UIData component.</description>
+        <description><![CDATA[
+          <p>
+          Creates a UIComponent that represents a single column of data within a parent UIData component.
+          </p>
+          <p>
+          This tag is commonly used as a child of the h:dataTable tag, to represent a column of
+          data within an html table. It can be decorated with nested "header" and "footer" facets
+          which cause the output of header and footer rows.
+          </p>
+          <p>
+          The non-facet child components of this column are re-rendered on each table row
+          to generate the content of the cell. Those child components can reference the "var"
+          attribute of the containing h:dataTable to generate appropriate output for each row.
+          </p>
+          ]]>
+        </description>
         <component-type>javax.faces.HtmlColumn</component-type>
         <component-class>javax.faces.component.html.HtmlColumn</component-class>
 

diff --git a/.../main/resources/META-INF/maven-faces-plugin/components/javax/faces/html/HtmlDataTable.xml b/.../main/resources/META-INF/maven-faces-plugin/components/javax/faces/html/HtmlDataTable.xml
@@ -19,14 +19,19 @@
               xmlns:h="http://java.sun.com/jsf/html"
               xmlns:xi="http://www.w3.org/2001/XInclude">
     <component>
-        <description>
-            This component renders as an HTML table element.  It has as its
-            children h:column entities, which describe the columns of the table.
-            It can be decorated with facets named "header" and "footer" to
-            specify header and footer rows.
-
-            Unless otherwise specified, all attributes accept static values
-            or EL expressions.
+        <description><![CDATA[
+            <p>
+            This component renders an HTML table element.
+            </p>
+            <p>
+            This component may have nested facets with names "header" and "footer"
+            to specify header and footer rows.
+            </p>
+            <p>
+            The non-facet children of this component are expected to be
+            h:column components which describe the columns of the table.
+            </p>
+            ]]>
         </description>
 
         <!-- SPEC PAGE 299-300 column 1-->

diff --git a/...in/resources/META-INF/maven-faces-plugin/components/javax/faces/html/HtmlGraphicImage.xml b/...in/resources/META-INF/maven-faces-plugin/components/javax/faces/html/HtmlGraphicImage.xml
@@ -19,9 +19,14 @@
               xmlns:h="http://java.sun.com/jsf/html"
               xmlns:xi="http://www.w3.org/2001/XInclude">
     <component>
-        <description>Renders an HTML img element.
-Unless otherwise specified, all attributes accept static values
-or EL expressions.</description>
+        <description><![CDATA[
+          <p>Renders an HTML img element.</p>
+          <p>
+          The value attribute specifies the url of the image to be displayed;
+          see the documentation for attribute "url" for more details.
+          </p>
+          ]]>
+        </description>
         <component-type>javax.faces.HtmlGraphicImage</component-type>
         <component-class>javax.faces.component.html.HtmlGraphicImage</component-class>
 

diff --git a/...rc/main/resources/META-INF/maven-faces-plugin/components/javax/faces/html/HtmlMessage.xml b/...rc/main/resources/META-INF/maven-faces-plugin/components/javax/faces/html/HtmlMessage.xml
@@ -19,10 +19,10 @@
               xmlns:h="http://java.sun.com/jsf/html"
               xmlns:xi="http://www.w3.org/2001/XInclude">
     <component>
-        <description>Renders the first FacesMessage that is assigned to the component
-referenced by the "for" attribute.
-Unless otherwise specified, all attributes accept static values
-or EL expressions.</description>
+        <description>
+          Renders text displaying information about the first FacesMessage
+          that is assigned to the component referenced by the "for" attribute.
+        </description>
         <component-class>javax.faces.component.html.HtmlMessage</component-class>
         <component-type>javax.faces.HtmlMessage</component-type>
 

diff --git a/.../main/resources/META-INF/maven-faces-plugin/components/javax/faces/html/HtmlPanelGrid.xml b/.../main/resources/META-INF/maven-faces-plugin/components/javax/faces/html/HtmlPanelGrid.xml
@@ -19,14 +19,17 @@
               xmlns:h="http://java.sun.com/jsf/html"
               xmlns:xi="http://www.w3.org/2001/XInclude">
     <component>
-        <description>This element renders as an HTML table with specified number of
-columns.  Children of this element are rendered as cells in the
-table, filling rows from left to right.  Facets named "header"
-and "footer" are optional and specify the content of the thead
-and tfoot rows, respectively.
-
-Unless otherwise specified, all attributes accept static values
-or EL expressions.</description>
+        <description><![CDATA[
+           <p>
+           This element renders as an HTML table with specified number of columns.
+           </p>
+           <p>
+           Children of this element are rendered as cells in the table, filling
+           rows from left to right.  Facets named "header" and "footer" are optional
+           and specify the content of the thead and tfoot rows, respectively.
+           </p>
+           ]]>
+        </description>
         <component-class>javax.faces.component.html.HtmlPanelGrid</component-class>
         <component-type>javax.faces.HtmlPanelGrid</component-type>
 
@@ -73,7 +76,12 @@ or EL expressions.</description>
         </property>
 
         <property>
-            <description>CSS class to be used for the columns.</description>
+            <description>
+              A comma separated list of CSS class names to apply to td elements in each column.
+              The first item in the list gets applied to the first column, the second item in
+              the list gets applied to the second column, etc. After all entries in the list
+              have been used, the list repeats again.
+            </description>
             <property-name>columnClasses</property-name>
             <property-class>java.lang.String</property-class>
             <property-extension>
@@ -100,7 +108,13 @@ or EL expressions.</description>
         </property>
 
         <property>
-            <description>CSS class to be used for the rows.</description>
+            <description><![CDATA[
+              A comma separated list of CSS class names to apply to td elements in each row.
+              The first item in the list gets applied to the first row, the second item in
+              the list gets applied to the second row, etc. After all entries in the list
+              have been used, the list repeats again.
+              ]]>
+            </description>
             <property-name>rowClasses</property-name>
             <property-class>java.lang.String</property-class>
             <property-extension>