ICEfaces-EE
  1. ICEfaces-EE
  2. IPCK-106

Add Composite Component JavaDoc output to the EE bundle, and online Wiki documentation.

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 1.8.2.GA_P01
    • Fix Version/s: 1.8.2.GA_P02
    • Component/s: Facelet Components
    • Labels:
      None
    • Environment:
      ICEfaces EE ICEpack Composite Components
    • Affects:
      Documentation (User Guide, Ref. Guide, etc.)

      Description

      Currently, we do not generate and distribute the JavaDocs for the Composite Components themselves, other than the TLD docs. We need to do so for the next release.

      This will require changes to the "ant bundle.build" target to have the Composite Components JavaDoc'ed as part of the build process.

        Activity

        Ken Fyten created issue -
        Ken Fyten made changes -
        Field Original Value New Value
        Salesforce Case []
        Fix Version/s 1.8.2.GA_P02 [ 10225 ]
        Affects [Documentation (User Guide, Ref. Guide, etc.)]
        Assignee Brad Kroeger [ brad.kroeger ] Philip Breau [ philip.breau ]
        Ken Fyten made changes -
        Link This issue blocks IPCK-105 [ IPCK-105 ]
        Ken Fyten made changes -
        Salesforce Case []
        Assignee Priority P1
        Assignee Philip Breau [ philip.breau ] Carlo Guglielmin [ carlo.guglielmin ]
        Hide
        Carlo Guglielmin added a comment -

        For the upcoming EE release. Most likely an ant build script change to generate the javadocs.

        Show
        Carlo Guglielmin added a comment - For the upcoming EE release. Most likely an ant build script change to generate the javadocs.
        Carlo Guglielmin made changes -
        Assignee Carlo Guglielmin [ carlo.guglielmin ] Nils Lundquist [ nils.lundquist ]
        Hide
        Ken Fyten added a comment -

        Okay, I've added the new 'javadoc' ant target to the composite-components build.xml. It will generate the JavaDoc for all composite components and copy it into the docs/javadoc dir.

        Sending /svn/icepack/icepack/composite-components/build.properties
        Sending /svn/icepack/icepack/composite-components/build.xml
        Committed revision 25078.

        Show
        Ken Fyten added a comment - Okay, I've added the new 'javadoc' ant target to the composite-components build.xml. It will generate the JavaDoc for all composite components and copy it into the docs/javadoc dir. Sending /svn/icepack/icepack/composite-components/build.properties Sending /svn/icepack/icepack/composite-components/build.xml Committed revision 25078.
        Ken Fyten made changes -
        Assignee Nils Lundquist [ nils.lundquist ] Ken Fyten [ ken.fyten ]
        Hide
        Ken Fyten added a comment -

        Alright, created new Wiki page linking to the online API docs: http://wiki.icesoft.com/display/ICEpack/API+Documentation

        Resolved.

        Show
        Ken Fyten added a comment - Alright, created new Wiki page linking to the online API docs: http://wiki.icesoft.com/display/ICEpack/API+Documentation Resolved.
        Ken Fyten made changes -
        Status Open [ 1 ] Resolved [ 5 ]
        Assignee Priority P1
        Resolution Fixed [ 1 ]
        Ken Fyten made changes -
        Status Resolved [ 5 ] Closed [ 6 ]

          People

          • Assignee:
            Ken Fyten
            Reporter:
            Ken Fyten
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: