Unified JavaDoc for RCP Module Suite

[tab]

I'm using NetBeans 6.0 to create an RCP application. I want to create a single unified set of javadocs in one directory with one index that covers all of the modules in my module suite.

Based on this thread:
http://www.nabble.com/Re%3A-WorkingCopy.getCommandEnvironment%28%29-to7986757.html#a7987834
I was able to add a javadoc-all ant target to my module suite's build.xml:

    <target name="javadoc-all" depends="build" description="Build javadoc for all modules in the suite.">
        <subant target="javadoc"
              buildpath="${modules.sorted}"
              inheritrefs="false"
              inheritall="false">
            <property name="netbeans.javadoc.dir" location="./doc/javadoc"/>
        </subant>
    </target>

...which builds the javadocs for all of my modules and outputs under one directory. But these are still separate javadocs for each module. How can I build a single javadoc index for all of my modules?

Is there a better way to do this? Is it different in NB 6.1? For example is there a "Generate JavaDocs" tool that works on module suites?

[tomwheel]

It is not (yet) possible to inherently do this in the NetBeans
Platform build harness.  However, it is a feature that I expect will
be available in the future.

The NetBeans IDE is built using a different, but similar, build
scripts which use XSL to do this.  The PlatformX project (kind of an
incubator for platform-related code) has a simplified version of this
which should work for platform-related applications.  To find it,
check out the code as described here:

   http://netbeans.ath.cx/

and look in the platformx_build directory.  I am anxious to try it out
the extra javadoc support but have not gotten a chance to do so yet.

On Wed, May 7, 2008 at 9:05 PM, tab <tblume@...> wrote:
>
> I'm using NetBeans 6.0 to create an RCP application. I want to create a
> single unified set of javadocs in one directory with one index that covers
> all of the modules in my module suite.
>



--
Tom Wheeler
http://www.tomwheeler.com/

[Andrey V. Kiliyevich]

Hello.

I'm use the following.

Module Suit - Important files - Build script:
add, for example, the following:

    <target name="javadoc-all" depends="-init" description="Build javadoc for several modules in the suite.">
        <javadoc destdir="../doc/" packagenames="your.company.com" overview="overview.html" encoding="UTF-8"
                classpath="../module.wrapper/release/modules/ext/foo.jar">
            <doctitle>
                <![CDATA[<h1>Some Title</h1>]]>
            </doctitle>
            <group title="Group 1" packages="your.company.com.package1*"/>
            <group title="Group 2" packages="your.company.com.package2*"/>
            <sourcepath location="../module1/src"/>
            <sourcepath location="../module2/src"/>
            <sourcepath location="../module3/src"/>
            <sourcepath location="../module4/src"/>
            <sourcepath location="../module5/src"/>
            <header>Some Header</header>
            <bottom><![CDATA[<i>Copyright © 2008 Your Company Name. All Rights Reserved.</i>]]></bottom>

        </javadoc>
        <nbbrowse file="../doc/index.html"/>        
    </target>


Where module1...module5, etc - the list of molules, for which you want to generate JavaDoc.
Group1...Group2, etc - for grouping of packages (optionally).
classpath - external jar files.

Then expand build script, right-click 'javadoc-all' and run it.

---
Question.
How to generate foregoing list of modules (except wrappers) and list of all jar
files (from all module wrappers) automatically(!)?

How to attach arch.xml for local(!) JavaDoc generation?
I'm trying to use 'netbeans.sources/nbbuild/javadoctools/' but unsuccessful.

---
You wrote 9 ??? 2008 ?., 4:33:26:

> It is not (yet) possible to inherently do this in the NetBeans
> Platform build harness.  However, it is a feature that I expect will
> be available in the future.

> The NetBeans IDE is built using a different, but similar, build
> scripts which use XSL to do this.  The PlatformX project (kind of an
> incubator for platform-related code) has a simplified version of this
> which should work for platform-related applications.  To find it,
> check out the code as described here:

>    http://netbeans.ath.cx/

> and look in the platformx_build directory.  I am anxious to try it out
> the extra javadoc support but have not gotten a chance to do so yet.

> On Wed, May 7, 2008 at 9:05 PM, tab <tblume@...> wrote:
>>
>> I'm using NetBeans 6.0 to create an RCP application. I want to create a
>> single unified set of javadocs in one directory with one index that covers
>> all of the modules in my module suite.
>>


---
Best regards,
Andrey