[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
Currently teher is not such place, that was a suggestion. I do not
believe we need to generate javadocs for every build. I believe
base eclipse updates it for each release.
So, if we did generate a java doc, mayb eeach milestone would be
ok.
So we can follwo a standard such as:
www.eclipse.org/webtools/docs/<release-tag>
As the prefix. It is easy to commit these to CVS as wtp
website has moved to CVS now.
Naci
At 11:15 PM 12/3/2004, Brad Blancett wrote:
Thanks
Michael,
I give this a try, we should at least be able to manually
publish our docs. Naci, was
www.eclipse.org/webtools/docs/1.0M2
the final destination for the published doc?
thanks for all the help,
Brad Blancett
IBM Software Solutions
T/L 3-2650
Michael Elder/Cambridge/IBM@IBMUS
Sent by: wtp-dev-admin@xxxxxxxxxxx
12/03/2004 02:49 PM
Please respond to wtp-dev
To: wtp-dev@xxxxxxxxxxx
cc:
Subject: Re: [wtp-dev] Java Doc
Extended Team:
This may be common knowledge but it was new to me:
As for the absolute path issue we can specify an attribute to the javadoc Ant task: link="". This attribute specifies a root URL. By specifying an empty string, you can generate relative paths. (See http://ant.apache.org/manual/index.html and click "Core Tasks> Javadoc" for more info.
-------------------------------------------------------------------------
Kind Regards,
Michael D. Elder
Rational Studio / J2EE Tools Development
IBM RTP Lab
Ext: (919) 543-8356
T/L: 441-8356
mdelder@xxxxxxxxxx
Friday, December 03, 2004 2:21 PM
To: wtp-dev@xxxxxxxxxxx
cc:
From: Brad Blancett/Raleigh/IBM@IBMUS
Subject: Re: [wtp-dev] Java Doc
Thanks Amy,
That helps, I havent seen a buildDoc.xml in the repo, so it looks like there is some work that needs to be done here.
I also noticed the index.jsp in the link you provided below, so their help system, must be wrapped in war, allowing them to get around the path issue.
Brad Blancett
IBM Software Solutions
Tie 3-2650
Amy Wu/Raleigh/IBM@IBMUS
Sent by: wtp-dev-admin@xxxxxxxxxxx
12/03/2004 11:20 AM
Please respond to wtp-dev
To: wtp-dev@xxxxxxxxxxx
cc:
Subject: Re: [wtp-dev] Java Doc
From my observations, the eclipse documentation is generated as part of the sdk build process. The JDT and platform javadoc are generated in the below plug-ins:
org.eclipse.platform.doc.isv http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.platform.doc.isv/
org.eclipse.jdt.doc.isv http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.jdt.doc.isv/
Both of those plugins have their own custom build.xml included in the plugins, so when sdk is built, the build script uses the already provided build.xml rather than auto-generating one like it does with all the other plugins. WTP could do the same and copy their build.xml & buildDoc.xml and substitute in the classpath, package names, source folders, etc (maybe using the javadoc wizard to get all that information). After the javadoc is generated, it is put into the eclipse help system. So all eclipse does is publish their entire help system. (http://help.eclipse.org/help30/index.jsp)
______________________________
Amy Wu
Structured Source Editor
919.254.0299, T/L 444.0299
amywu@xxxxxxxxxx
Brad Blancett/Raleigh/IBM@IBMUS
Sent by: wtp-dev-admin@xxxxxxxxxxx
12/03/2004 10:06 AM
Please respond to
wtp-dev
To
wtp-dev@xxxxxxxxxxx
cc
Subject
Re: [wtp-dev] Java Doc
Naci,
I agree it should be a downloadable zip, and published. I assume the build script will need to be updated with the javadoc ant task. I did a manual generation of our java docs using the export wizard in the workbench and noticed the generated html files have absolute paths. The links will only work on the machine that generates them. Does anyone know what the base eclipse process is? We could always wrap our java docs in a war, or have a link on eclipse.org that points to our build machine. What do you think?
Thanks
Brad Blancett
IBM Software Solutions
Tie 3-2650
Naci Dai <naci.dai@xxxxxxxxxxxxx>
Sent by: wtp-dev-admin@xxxxxxxxxxx
12/02/2004 06:32 AM
Please respond to wtp-dev
To: wtp-dev@xxxxxxxxxxx
cc:
Subject: Re: [wtp-dev] Java Doc
I believe it should be a part of the regular build process. However, it could make sense to do it only for M/S builds.
We can publihs them on the web:
e.g. www.eclipse.org/webtools/docs/1.0M2 maybe?
Of course we can also zip them and make then available with the build on the downloads page.
At 11:51 PM 12/1/2004, Brad Blancett wrote:
Naci,
Is java doc generation going to be part of the build? If not,, is there (or going to be) a standard place where we should publish them?
Thanks,
Brad Blancett
IBM Software Solutions
Tie 3-2650
Naci Dai,
Managing Director
eteration a.s.
Inonu cad. Sumer sok. Zitas D1-15
Kozyatagi, Istanbul 81090
+90 (532) 573 7783 (cell)
+90 (216) 361 5434 (phone)
+90 (216) 361 2034 (fax)
http://www.eteration.com
mailto:nacidai@xxxxxxx
mailto:naci@xxxxxxxxxxxxx
Naci Dai,
Managing Director
eteration a.s.
Inonu cad. Sumer sok. Zitas D1-15
Kozyatagi, Istanbul 81090
+90 (532) 573 7783 (cell)
+90 (216) 361 5434 (phone)
+90 (216) 361 2034 (fax)
http://www.eteration.com
mailto:nacidai@xxxxxxx
mailto:naci@xxxxxxxxxxxxx
