Details
-
Type:
Bug
-
Status: Closed
-
Priority:
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
- All
- Comments
- History
- Activity
- Remote Attachments
- Subversion
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.
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.