ICEfaces
  1. ICEfaces
  2. ICE-6112

ACE generator - output documentation from non-TLD source(s)

    Details

    • Type: New Feature New Feature
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.0-Beta2
    • Fix Version/s: 2.1-Beta, 3.0
    • Component/s: ACE-Components
    • Labels:
      None
    • Environment:
      sparkle
    • Assignee Priority:
      P1

      Description

      JSF 2 provides a new taglib.xml schema, and a new faces-config.xml schema, and comes with new files that describe the h: components and classes.

      Here's how the action attribute/property is documented in each. As you can see, the faces-config documentation seems to be a superset of the taglib.xml one:

      mojarra2\jsf-ri\conf\share\html_basic.taglib.xml [ taglib.xml ]

              <attribute>
                  <description>
                      MethodExpression representing the application action to invoke
                      when this component is activated by the user. The expression
                      must evaluate to a public method that takes no parameters, and
                      returns an Object (the toString() of which is called to derive
                      the logical outcome) which is passed to the NavigationHandler
                      for this application.
                  </description>
                  <name>action</name>
                  <required>false</required>
                  <method-signature>java.lang.Object action()</method-signature>
              </attribute>

      mojarra2\jsf-api\doc\standard-html-renderkit.xml

          <property>
            <description>
                MethodExpression representing the application action to invoke
                when this component is activated by the user. The expression
                must evaluate to a public method that takes no parameters, and
                returns an Object (the toString() of which is called to derive
                the logical outcome) which is passed to the NavigationHandler
                for this application.
              </description>
            <display-name>Application Action</display-name>
            <icon/>
            <property-name>action</property-name>
            <property-class>javax.el.MethodExpression</property-class>
            <property-extension>
              <method-signature>
                      java.lang.Object action()
                  </method-signature>
            </property-extension>
          </property>

      Since the faces-config documentation provides more information than the old JSP style TLD, we should probably generate it, and find a way to create our HTML component documentation from it, hopefully using a pre-existing tool that Mojarra or MyFaces might be making use of themselves. Alternatively, we might consider generating our HTML documentation straight from our Meta classes. Lastly, we can simply shoe-horn our newer data into the TLD component description field, and continue using the existing tlddoc tool.

        Issue Links

          Activity

          Mark Collette created issue -
          Mark Collette made changes -
          Field Original Value New Value
          Link This issue blocks ICE-6111 [ ICE-6111 ]
          Mark Collette made changes -
          Link This issue blocks ICE-6110 [ ICE-6110 ]
          Mark Collette made changes -
          Salesforce Case []
          Affects Version/s 2.0-Beta2 [ 10242 ]
          Affects Version/s 2.0-Beta1 [ 10231 ]
          Ken Fyten made changes -
          Salesforce Case []
          Fix Version/s 2.0-Beta2 [ 10242 ]
          Assignee Greg Dick [ greg.dick ]
          Ken Fyten made changes -
          Summary sparkle generator output documentation from non-TLD source(s) ACE generator - output documentation from non-TLD source(s)
          Salesforce Case []
          Component/s ACE-Components [ 10050 ]
          Component/s Components [ 10012 ]
          Fix Version/s 2.0.0 [ 10230 ]
          Fix Version/s 2.0-Beta2 [ 10242 ]
          Security Private [ 10001 ]
          Priority Major [ 3 ] Minor [ 4 ]
          Ken Fyten made changes -
          Salesforce Case []
          Assignee Priority P3
          Ken Fyten made changes -
          Assignee Priority P3 P2
          Ken Fyten made changes -
          Salesforce Case []
          Fix Version/s 2.1 [ 10241 ]
          Fix Version/s 2.0.0 [ 10230 ]
          Assignee Priority P2
          Ken Fyten made changes -
          Salesforce Case []
          Assignee Priority P2
          Assignee Greg Dick [ greg.dick ] Arturo Zambrano [ artzambrano ]
          Ken Fyten made changes -
          Salesforce Case []
          Assignee Priority P2 P1
          Arturo Zambrano made changes -
          Salesforce Case []
          Priority Minor [ 4 ] Major [ 3 ]
          Mark Collette made changes -
          Link This issue blocks ICE-6185 [ ICE-6185 ]
          Arturo Zambrano made changes -
          Status Open [ 1 ] Resolved [ 5 ]
          Resolution Fixed [ 1 ]
          Ken Fyten made changes -
          Fix Version/s 2.1-Beta [ 10291 ]
          Ken Fyten made changes -
          Resolution Fixed [ 1 ]
          Status Resolved [ 5 ] Reopened [ 4 ]
          Arturo Zambrano made changes -
          Status Reopened [ 4 ] Resolved [ 5 ]
          Resolution Fixed [ 1 ]
          Ken Fyten made changes -
          Status Resolved [ 5 ] Closed [ 6 ]

            People

            • Assignee:
              Arturo Zambrano
              Reporter:
              Mark Collette
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: