srinivas
Posts: 54
|
| Posted: 04/11/2004, 11:02 AM |
|
Any one ran javadoc on CCS projects before? Can you share your experience? Thanks.
-Srinivas
|
 |
 |
Don Zorro
|
| Posted: 04/12/2004, 10:22 PM |
|
Here are my notes. I have included Tomcat javax sources, so the generated documentation has all the links working.
CCJavadoc - javadoc docs for CodeCharge (2.2.3.60) java classes.
----------------------------------------------------------------
SB: 02/11/2004
1. This documentation uses javax servlet classes used in Tomcat
ver. 4.1.24. The source package 'jakarta-servletapi' is from:
http://cvs.apache.org/builds/jakarta-servletapi-4/nightly/src
and has been copied to the CodeCharge generated 'src' directory
prior generating the documentation:
From BASH prompt:
wget http://cvs.apache.org/.../jakarta-servletapi-4-src-xxx.zip
cd /tmp; unzip jakarta-servletapi-4-src-xxx.zip
cp jakarta-servletapi-4/src/share/javax /d/VCentrix/CCSBuild/src
cd /d/VCentrix/CCSBuild/src
ls
$ com javax
From DOS command line:
cd D:\Project\vcentrix\CCSBuild\src
javadoc -d D:\Project\CCJavadoc -sourcepath . -subpackages com:javax
(Several warning "@xxx is not a parameter name" is expected.)
The resulting html documentation (7MB) is in D:\Project\CCJavadoc.
|
|
|
|
ignat
Posts: 55
|
| Posted: 04/12/2004, 11:51 PM |
|
The generated CCSBuild/build.xml also has a 'doc' target, which you can run
to generate JavaDoc. You only need to change nested <link> elements for
links to JDK and Servlet API javaDoc. And for that you may need a package-list,
which you can download from: http://java.sun.com/webservices/docs/ea2/api/package-list
and http://java.sun.com/j2se/1.3/docs/api/package-list
Regards,
Ignat.
|
|
|
|
dekacode
Posts: 53
|
| Posted: 07/20/2004, 4:56 PM |
|
Ignat,
Could you provide more details on how docs are generated.
How does build.xml relate to javadoc?
|
|
|
|
dekacode
Posts: 53
|
| Posted: 07/20/2004, 6:28 PM |
|
Ignat,
'javadoc' is a task of the 'doc' target in build.xml.
The target below does not automatically generate docs.
Could you post an example of an Ant target that generates CCS docs?
<target name="doc" depends="init">
<mkdir dir="doc"/>
<javadoc packagenames="com.codecharge.*"
sourcePath="src"
classpath="${cp}"
destdir="doc"
Windowtitle="CCS JSP pattern API Documentation"
Doctitle="CodeCharge Studio JSP pattern API Documentation">
<link href="http://java.sun.com/j2se/1.3/docs/api/" offline="true" packagelistLoc="c:\java\plists\jdk13"/>
<link href="http://java.sun.com/webservices/docs/ea2/api/" offline="true" packagelistLoc="c:\java\plists\ws"/>
</javadoc>
</target>
|
|
|
|
ignat
Posts: 55
|
| Posted: 07/26/2004, 6:21 AM |
|
Dekacode,
Run doc target of the generated build.xml with ant to generate your own copy of javadoc documentation.
C:\ccsprojects\Sample\CCSBuild>ant doc
Regards,
Ignat.
|
|
|
|
