Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Buckminster » Building Javadoc of multiple projects
Building Javadoc of multiple projects [message #760443] Fri, 02 December 2011 11:45 Go to next message
Thorsten Meinl is currently offline Thorsten MeinlFriend
Messages: 85
Registered: July 2009
Member
Hi all,

Here is a hard one I've been struggling with for quite some hours. We
have several plug-in projects and want to build a combined Javadoc.
Headless of course, so the Eclipse wizard is of no use. I thought about
creating a feature, adding all plug-in as dependencies, and then use an
ant tasks to create the javadoc via a CSpec extensions. However, there
are two main issues:

- The components don't have a public attribute telling their source
directory (and this is *not* always the same in all plug-ins)
- The components don't tell me their full classpath i.e. required
plug-ins and local jar files.

I could to it by adding manually public attributes to all plug-ins but
that is cumbersome and for each new plug-in it is easy to forget.

The required information is available somehow since Eclipse can do it.
My next thought was creating some kind of actor and then use the BM Java
classes to traverse the dependency tree and collect the required
information somehow, but I couldn't find a way to do this. I have the
CSpec of the feature at hand, but how do I get to the CSpecs of all
dependencies (recursively)?

Or is there a different approach?

Cheers,

Thorsten
Re: Building Javadoc of multiple projects [message #760518 is a reply to message #760443] Fri, 02 December 2011 16:39 Go to previous messageGo to next message
Thomas Hallgren is currently offline Thomas HallgrenFriend
Messages: 3232
Registered: July 2009
Senior Member
On 2011-12-02 12:45, Thorsten Meinl wrote:
> Hi all,
>
> Here is a hard one I've been struggling with for quite some hours. We
> have several plug-in projects and want to build a combined Javadoc.
> Headless of course, so the Eclipse wizard is of no use. I thought about
> creating a feature, adding all plug-in as dependencies, and then use an
> ant tasks to create the javadoc via a CSpec extensions. However, there
> are two main issues:
>
> - The components don't have a public attribute telling their source
> directory (and this is *not* always the same in all plug-ins)

Sure they do. That's the component itself, i.e. the component without an
attribute.

> - The components don't tell me their full classpath i.e. required
> plug-ins and local jar files.
>
Look at the prerequisites that are used as input for the eclipse.build
action. Not exactly the classpath but it might be of some help in this case.

> I could to it by adding manually public attributes to all plug-ins but
> that is cumbersome and for each new plug-in it is easy to forget.
>
> The required information is available somehow since Eclipse can do it.

An enhancement requiest to make this available in Buckminster is very
welcome. Is this functionality available headless?

> My next thought was creating some kind of actor and then use the BM Java
> classes to traverse the dependency tree and collect the required
> information somehow, but I couldn't find a way to do this. I have the
> CSpec of the feature at hand, but how do I get to the CSpecs of all
> dependencies (recursively)?
>
I think we should be able to provide a better solution for this,
especially if Eclipse already provides the functionality.

- thomas
Re: Building Javadoc of multiple projects [message #762704 is a reply to message #760518] Thu, 08 December 2011 14:26 Go to previous message
Thorsten Meinl is currently offline Thorsten MeinlFriend
Messages: 85
Registered: July 2009
Member
>> - The components don't have a public attribute telling their source
>> directory (and this is *not* always the same in all plug-ins)
>
> Sure they do. That's the component itself, i.e. the component without an
> attribute.
Hm, but doesn't seem to gives me the source folders:
<attribute name="buckminster.component.self" component="bla" />
gives me the root of the component but not its source folder(s).
I essentially need the attribute eclipse.build.source being public, this
is exactly the information required for the "-sourcepath"-parameter of
Javadoc.

>> - The components don't tell me their full classpath i.e. required
>> plug-ins and local jar files.
>>
> Look at the prerequisites that are used as input for the eclipse.build
> action. Not exactly the classpath but it might be of some help in this
> case.
The classpath should be the combination of java.binaries and
bin.includes but again, those two are private attributes and one needs
to modify each component to make the publicly visible.


>> The required information is available somehow since Eclipse can do it.
>
> An enhancement requiest to make this available in Buckminster is very
> welcome. Is this functionality available headless?
I couldn't find a way to build the Javadoc headless in Eclipse. There is
only the wizard (which also create an Ant-script, but with absolute paths).

>> My next thought was creating some kind of actor and then use the BM Java
>> classes to traverse the dependency tree and collect the required
>> information somehow, but I couldn't find a way to do this. I have the
>> CSpec of the feature at hand, but how do I get to the CSpecs of all
>> dependencies (recursively)?
>>
> I think we should be able to provide a better solution for this,
> especially if Eclipse already provides the functionality.
This would be great. I will open a feature request for this.
In the meantime is there some way to traverse the dependency tree and
accessing the attributes programmatically as I described before?

Cheers,

Thorsten
Previous Topic:Illegal State in Profile Timestamp
Next Topic:Resolution / Materialization / Build times
Goto Forum:
  


Current Time: Sun Dec 21 02:05:50 GMT 2014

Powered by FUDForum. Page generated in 0.14431 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software