ICEfaces
  1. ICEfaces
  2. ICE-6547

Need to audit the ICEfaces 1.8 core for JavaDocs

          Details

          • Type: Bug Bug
          • Status: Closed
          • Priority: Major Major
          • Resolution: Fixed
          • Affects Version/s: 1.8.2a, 1.8.2-EE-GA_P02
          • Fix Version/s: 1.8.3, EE-1.8.2.GA_P03
          • Component/s: Documentation, Framework
          • Labels:
            None
          • Environment:
            ICEfaces 1.x Core JavaDocs
          • Affects:
            Documentation (User Guide, Ref. Guide, etc.)

            Description

            It looks like there may be some APIs in the ICEfaces 1.8 core that are either missing JavaDocs are are not included in the fileset for the JavaDoc build target. We need to audit the classes to ensure public APIs have appropriate JavaDocs and that they are included in the build's javadoc target fileset.

              Activity

              Ascending order - Click to sort in descending order
              Deryk Sinotte created issue -
              Deryk Sinotte made changes -
              Field Original Value New Value
              Assignee Deryk Sinotte [ deryk.sinotte ]
              Ken Fyten made changes -
              Salesforce Case []
              Affects [Documentation (User Guide, Ref. Guide, etc.)]
              Ken Fyten made changes -
              Assignee Deryk Sinotte [ deryk.sinotte ] Ken Fyten [ ken.fyten ]
              Ken Fyten made changes -
              Salesforce Case []
              Assignee Priority P1
              Assignee Ken Fyten [ ken.fyten ] Deryk Sinotte [ deryk.sinotte ]
              Hide
              Permalink
              Deryk Sinotte added a comment -

              After reviewing the core code, I've determined that the following classes should likely be added to the build.xml file in the javadoc target so that they are included in the JavaDocs for the product:

              <include name="com/icesoft/faces/context/FileResource.java"/>
              <include name="com/icesoft/faces/context/JarResource.java"/>
              <include name="com/icesoft/faces/context/ResourceRegistry.java"/>
              <include name="com/icesoft/faces/context/StringResource.java"/>
              <include name="com/icesoft/faces/webapp/xmlhttp/BlockingServlet.java"/>
              <include name="com/icesoft/faces/webapp/xmlhttp/PersistentFacesServlet.java"/>
              <include name="com/icesoft/faces/webapp/http/servlet/MainServlet.java"/>
              <include name="com/icesoft/faces/webapp/http/servlet/TouchSessionFilter.java"/>
              <include name="com/icesoft/faces/webapp/http/portlet/MainPortlet.java"/>
              <include name="com/icesoft/faces/webapp/parser/ImplementationUtil.java"/>

              Some are being added not so much for their API but more to ensure their visibility as external entry points into the ICEfaces framework. Where necessary, I'll add class-level comments.

              Show
              Deryk Sinotte added a comment - After reviewing the core code, I've determined that the following classes should likely be added to the build.xml file in the javadoc target so that they are included in the JavaDocs for the product: <include name="com/icesoft/faces/context/FileResource.java"/> <include name="com/icesoft/faces/context/JarResource.java"/> <include name="com/icesoft/faces/context/ResourceRegistry.java"/> <include name="com/icesoft/faces/context/StringResource.java"/> <include name="com/icesoft/faces/webapp/xmlhttp/BlockingServlet.java"/> <include name="com/icesoft/faces/webapp/xmlhttp/PersistentFacesServlet.java"/> <include name="com/icesoft/faces/webapp/http/servlet/MainServlet.java"/> <include name="com/icesoft/faces/webapp/http/servlet/TouchSessionFilter.java"/> <include name="com/icesoft/faces/webapp/http/portlet/MainPortlet.java"/> <include name="com/icesoft/faces/webapp/parser/ImplementationUtil.java"/> Some are being added not so much for their API but more to ensure their visibility as external entry points into the ICEfaces framework. Where necessary, I'll add class-level comments.
              Repository Revision Date User Message
              ICEsoft Public SVN Repository #24772 Wed Jun 08 09:07:08 MDT 2011 deryk.sinotte ICE-6547: update JavaDocs to include any missing core classes and some cleanup
              Files Changed
              Commit graph MODIFY /icefaces/trunk/icefaces/core/src/com/icesoft/faces/async/render/OnDemandRenderer.java
              Commit graph MODIFY /icefaces/trunk/icefaces/core/src/com/icesoft/faces/webapp/http/servlet/MainServlet.java
              Commit graph MODIFY /icefaces/trunk/icefaces/core/src/com/icesoft/faces/webapp/xmlhttp/PersistentFacesServlet.java
              Commit graph MODIFY /icefaces/trunk/icefaces/core/src/com/icesoft/faces/webapp/parser/ImplementationUtil.java
              Commit graph MODIFY /icefaces/trunk/icefaces/core/src/com/icesoft/faces/webapp/xmlhttp/BlockingServlet.java
              Commit graph MODIFY /icefaces/trunk/icefaces/core/src/com/icesoft/faces/async/render/DelayRenderer.java
              Commit graph MODIFY /icefaces/trunk/icefaces/core/src/com/icesoft/faces/async/render/IntervalRenderer.java
              Commit graph MODIFY /icefaces/trunk/icefaces/core/src/com/icesoft/faces/context/ResourceRegistry.java
              Commit graph MODIFY /icefaces/trunk/icefaces/core/src/com/icesoft/faces/webapp/http/servlet/TouchSessionFilter.java
              Commit graph MODIFY /icefaces/trunk/icefaces/core/src/com/icesoft/faces/async/render/RenderManager.java
              Commit graph MODIFY /icefaces/trunk/icefaces/core/src/com/icesoft/faces/context/FileResource.java
              Commit graph MODIFY /icefaces/trunk/icefaces/core/src/com/icesoft/faces/webapp/http/portlet/MainPortlet.java
              Commit graph MODIFY /icefaces/trunk/icefaces/core/build.xml
              Hide
              Permalink
              Deryk Sinotte added a comment -

              Committed the build file with the new classes to be JavaDoc'd as well as added some comments where needed. Also cleaned up some JavaDoc warnings in a few other areas.

              Show
              Deryk Sinotte added a comment - Committed the build file with the new classes to be JavaDoc'd as well as added some comments where needed. Also cleaned up some JavaDoc warnings in a few other areas.
              Deryk Sinotte made changes -
              Status Open [ 1 ] Resolved [ 5 ]
              Resolution Fixed [ 1 ]
              Repository Revision Date User Message
              ICEsoft Public SVN Repository #24789 Thu Jun 09 14:14:11 MDT 2011 deryk.sinotte ICE-6547: missed checking in a file for the JavaDoc cleanup
              Files Changed
              Commit graph MODIFY /icefaces/trunk/icefaces/core/src/com/icesoft/faces/async/render/GroupAsyncRenderer.java
              Ken Fyten made changes -
              Status Resolved [ 5 ] Closed [ 6 ]
              Assignee Priority P1

                People

                • Assignee:
                  Deryk Sinotte
                  Reporter:
                  Deryk Sinotte
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  0 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved: