[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
Re: [buckminster-dev] How to create JavaDoc
|
Hi Sharma,
The difference is mainly that a CSPEC action allow better control over
when the build is performed and what it is dependent upon. An action is
normally not performed unless you explicitly ask for it. A builder on
the other hand, is injected into the Eclipse build system and is
executed very frequently (when you save a file, periodic workspace
builds, etc.) and that might not be desirable for a Javadoc tasks since
it's quite heavy.
You can invoke a CSPEC action by right-clicking on the project and
choose 'Buckminster' -> 'Invoke Action'. A list pops up with possible
actions.
We intend to provide extension points so that actions can be tied to a
menu item of choice in the IDE, but the design of that is not finished yet.
Kind Regards,
Thomas Hallgren
Sharma, Jaikumar wrote:
Hi Thomas,
What is the difference in terms of advantages / disadvantages of
configuring an action in .CSPEC ? Because, it is also possible to
configure Buckminster builder to create a javadoc and run "buckminster
build" (which triggers the configured builders -- as many as one has
configured).
Regards.
-----Original Message-----
From: buckminster-dev-bounces@xxxxxxxxxxx
[mailto:buckminster-dev-bounces@xxxxxxxxxxx] On Behalf Of Thomas
Hallgren
Sent: Friday, September 29, 2006 05:26 PM
To: Buckminster developer discussions
Subject: Re: [buckminster-dev] How to create JavaDoc
Hi Sharma,
The easiest way to create javadoc is to add an action with an 'ant'
actor that calls on an
ant-script using the javadoc task. If you cspec is generated
(feature/plugins/maven
components), then add a cspec extension, i.e. a buckminster.cspex file
to your project where
you add the action. Something like:
<cs:actions>
<cs:public name="create.javadoc" actor="ant">
<cs:actorProperties>
<cs:property key="buildFile" value="make/build.xml"/>
</cs:actorProperties>
<cs:prerequisites>
<cs:local attribute="eclipse.build.source" alias="source"/>
</cs:prerequisites>
<cs:products>
<cs:public name="javadoc.output" base="docs/"/>
</cs:products>
</cs:private>
</cs:actions>
You then add the make/build.xml file and a target called
'create.javadoc'. You can access
the source in three ways:
<buckminster.filesetgroup refid="source.filesetgroup"/>
or:
<path refid="source"/>
or, since there in this case is only one fileset in the group:
<fileset refid="source.fileset"/>
In case there's zero or one path in the fileset, you can also access it
as a property, i.e.:
"${source}".
A more elaborate documentation that describes actions and the ant
integration will be added
to the wiki soon.
- thomas
Sharma, Jaikumar wrote:
> Dear.
>
> I want to create Javadoc for my project. I can see a lot of TODOs when
> I
> try to find ACTION for .CSPEC. This leads me in dark :-)
> If possible, can somebody give me some get going example to how to
> create Java doc for my project, please!
>
> Thanks for your help in advance!
>
> Regards
>
>
_______________________________________________
buckminster-dev mailing list
buckminster-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/buckminster-dev
- - - - - - - DISCLAIMER- - - - - - - -
Unless indicated otherwise, the information contained in this message
is privileged and confidential, and is intended only for the use of
the addressee(s) named above and others who have been specifically
authorized to receive it. If you are not the intended recipient, you
are hereby notified that any dissemination, distribution or copying of
this message and/or attachments is strictly prohibited. The company
accepts no liability for any damage caused by any virus transmitted by
this email. Furthermore, the company does not warrant a proper and
complete transmission of this information, nor does it accept
liability for any delays. If you have received this message in error,
please contact the sender and delete the message. Thank you.
------------------------------------------------------------------------
_______________________________________________
buckminster-dev mailing list
buckminster-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/buckminster-dev