Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [dsdp-tm-dev] How to generate the javadoc from latest CVSversions? 
Hi all,

few thoughts:
1.) Building the docs yourself:
RSE uses the standard PDE build also for docs, so basically it should be possible that a developer working on CVS selects the doc.isv plugin and does Export > Deployable Plugins and Fragments to generate the Javadoc. There are a few prerequisites for this to work - the most notable one being that all plugins in the workspace are on the same directory level, otherwise the cross referencing between javadoc for various modules would not work; the other one that a Platform ISV Doc needs to be available, again in order to generate xref into the platform docs. Uwe - I'm not sure why exactly "Export" doesnt work for you. If you are interested and you like Ant, it might be good to find the problem and make it work. For testing, you can select the plugin.xml of doc.isv, choose PDE Tools > Generate Ant Build File, then select the build.xml and do Run As > Ant. 

2.) ISV Doc only download
Note that the ISV Docs makes up most of the download size of the RSE SDK. People working on CVS are a somewhat special use case - I dont think it makes sense to provide a special feature just for them. They can download and install the SDK, then delete or deactivate plugins they dont need or like. 

Cheers
Martin


David Dykstal schrieb:
The documentation is also online at: http://dsdp.eclipse.org/help/ latest/index.jsp
While it might be useful to have a "doc only" feature, I believe the eclipse requirement is to have the ISV documentation packaged with the SDK. Perhaps this is something we could look into for the next release. 

---------------------------
Dave Dykstal
dykstal@xxxxxxx


On Oct 3, 2006, at 9:49 AM, Stieber, Uwe wrote:


Hi,
the only more or less satisfying way seems to be to have the Eclipse
used for Development refering to the RSE update side and install the SDK 
feature. That makes the documentation visible in parallel with the
platform API references as they share the same help browser.

Just for my interest, wouldn't it kind of useful to have a doc.isv  only
feature? Would be more light weight than the SDK feature and you don't
need the full RSE installed in your Dev Eclipse environment. Makes you
able to read the documentation (including all guides, extension points
and API reference) without blowing up of your development environment so 
much in terms of plugins and their dependencies.

Thanks, Cheers, Uwe

--
Uwe Stieber
Member of Technical Staff
Engineering - Wind River Gmbh - Austria


-----Original Message-----
From: dsdp-tm-dev-bounces@xxxxxxxxxxx
[mailto:dsdp-tm-dev-bounces@xxxxxxxxxxx] On Behalf Of David Dykstal
Sent: Dienstag, 03. Oktober 2006 13:25
To: Target Management developer discussions
Subject: Re: [dsdp-tm-dev] How to generate the javadoc from
latest CVSversions?

The latest javadoc should already be included in the builds - both
nightly and I builds. Generating it on your own is either
complicated
(setting up a full build environment) or simple (exporting javadoc),
depending on your needs. The buildDoc.xml script is used by
the build
environment which packages up the result so that it can be installed
in the IDE later.

The javadoc in the builds is built into plugins, and accessible from
the IDE, from both the help and through content assist.
---------------------------
Dave Dykstal
dykstal@xxxxxxx


On Oct 3, 2006, at 4:38 AM, Stieber, Uwe wrote:


Hi,
is there is any how to description for generating the most recent
javadoc out of CVS? Executing buildDoc.xml from plugin
org.eclipse.doc.isv, ant target "all" or generateJavaDoc seems not
to do
m very much.

Buildfile:
D:\Mounted_Data\Dev_Workspaces\wb-current\workspace
\org.eclipse.rse.doc.
isv\buildDoc.xml

init:
      [delete] Deleting directory
D:\Mounted_Data\Dev_Workspaces\wb-current\workspace
\org.eclipse.rse.doc.
isv\javadoc.link.location

all:

getJavadocPath:

extractLinks:
       [mkdir] Created dir:
D:\Mounted_Data\Dev_Workspaces\wb-current\workspace
\org.eclipse.rse.doc.
isv\javadoc.link.location
       [unzip] Expanding:
D:\Apps\eclipse\plugins
\org.eclipse.platform.doc.isv_3.2.0.v20060612-090
0.jar into
D:\Mounted_Data\Dev_Workspaces\wb-current\workspace
\org.eclipse.rse.doc.
isv\javadoc.link.location\platform

computeClasspath:
        [echo] Computing classpath ...
        [echo] Done computing classpath.

generateJavadoc:
BUILD SUCCESSFUL
Total time: 30 seconds

It seems to generate and index and the javadoc.link.location
folder, but
where is the ready to browse javadoc supposed to go?

Thanks in advance,
Cheers, Uwe

--
Uwe Stieber
Member of Technical Staff
Engineering - Wind River Gmbh - Austria
office: +43 662 457915 0
_______________________________________________
dsdp-tm-dev mailing list
dsdp-tm-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/dsdp-tm-dev


_______________________________________________
dsdp-tm-dev mailing list
dsdp-tm-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/dsdp-tm-dev


_______________________________________________
dsdp-tm-dev mailing list
dsdp-tm-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/dsdp-tm-dev


_______________________________________________
dsdp-tm-dev mailing list
dsdp-tm-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/dsdp-tm-dev




--
Martin Oberhuber
Wind River Systems, Inc.
Target Management Project Lead, DSDP PMC Member
http://www.eclipse.org/dsdp/tm

Back to the top