You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@tapestry.apache.org by Norbert Sándor <de...@erinors.com> on 2006/08/15 15:56:32 UTC
tapdoc
Hello,
I have converted Tapdoc to Maven2, so it now has a standard website at:
http://www.erinors.com/developer/project/tapdoc/
The jar and the source code is available from our maven2 repository.
You can download a Maven2-based demo application from the website as well.
(Please note:
- the Maven2 integration is partial, currently the ant-plugin is used to
integrate tapdoc to maven-based projects
- the source code needs further cleanup)
Regards,
Norbert Sándor
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
For additional commands, e-mail: users-help@tapestry.apache.org
Re: tapdoc
Posted by Norbert Sándor <de...@erinors.com>.
OK, I would.
andyhot wrote:
> thx Norbert!
>
> Just saw that we're not currently generating javadocs for contib (why???) at
> http://tapestry.apache.org/tapestry4.1/tapestry-contrib/apidocs/index.html
> but I guess you could already include this link in
> TapDocTask.java (for the external javadoc references)
>
> Norbert Sándor wrote:
>
>> Hello,
>>
>> I have converted Tapdoc to Maven2, so it now has a standard website
>> at: http://www.erinors.com/developer/project/tapdoc/
>> The jar and the source code is available from our maven2 repository.
>> You can download a Maven2-based demo application from the website as
>> well.
>>
>> (Please note:
>> - the Maven2 integration is partial, currently the ant-plugin is used
>> to integrate tapdoc to maven-based projects
>> - the source code needs further cleanup)
>>
>> Regards,
>> Norbert Sándor
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
>> For additional commands, e-mail: users-help@tapestry.apache.org
>>
>>
>>
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
For additional commands, e-mail: users-help@tapestry.apache.org
Re: tapdoc
Posted by andyhot <an...@di.uoa.gr>.
thx Norbert!
Just saw that we're not currently generating javadocs for contib (why???) at
http://tapestry.apache.org/tapestry4.1/tapestry-contrib/apidocs/index.html
but I guess you could already include this link in
TapDocTask.java (for the external javadoc references)
Norbert Sándor wrote:
> Hello,
>
> I have converted Tapdoc to Maven2, so it now has a standard website
> at: http://www.erinors.com/developer/project/tapdoc/
> The jar and the source code is available from our maven2 repository.
> You can download a Maven2-based demo application from the website as
> well.
>
> (Please note:
> - the Maven2 integration is partial, currently the ant-plugin is used
> to integrate tapdoc to maven-based projects
> - the source code needs further cleanup)
>
> Regards,
> Norbert Sándor
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
> For additional commands, e-mail: users-help@tapestry.apache.org
>
>
--
Andreas Andreou - andyhot@apache.org - http://andyhot.di.uoa.gr
Tapestry / Tacos developer
Open Source / J2EE Consulting
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
For additional commands, e-mail: users-help@tapestry.apache.org
Re: tapdoc
Posted by Norbert Sándor <de...@erinors.com>.
I think it's not...
If I remember well then when the components of a library are enumerated,
only those components are listed which have an explicit <component-type
/> declaration in the .library file. Pure Java components are not, so
they won't be included in the documentation by default. Pure Java
components should be explicitly declared as part of the library in an
XML file named LibraryName.library.tapdoc.
Similar possibility is given for components, in a
ComponentName.jwc.tapdoc file one could define additional component
information, like visual sample, example codes, etc.
I haven't documented the format of these XML files yet, but I would... :)
But of course annotations are supported and parameter descriptions are
extracted from the .java file (if available) using a custom javadoc doclet.
Regards,
Norbi
andyhot wrote:
> Henri Dupre wrote:
>
>> Oh this looks very nice!
>> Does tapdoc take into account also components with annotations that
>> have no
>> .jwc?
>>
>>
> It does... I think it uses a custom doclet to extract javadocs from
> those 'annotation-only'
> components
>
>> On 8/15/06, Norbert Sándor <de...@erinors.com> wrote:
>>
>>> Hello,
>>>
>>> I have converted Tapdoc to Maven2, so it now has a standard website at:
>>> http://www.erinors.com/developer/project/tapdoc/
>>> The jar and the source code is available from our maven2 repository.
>>> You can download a Maven2-based demo application from the website as
>>> well.
>>>
>>> (Please note:
>>> - the Maven2 integration is partial, currently the ant-plugin is used to
>>> integrate tapdoc to maven-based projects
>>> - the source code needs further cleanup)
>>>
>>> Regards,
>>> Norbert Sándor
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
>>> For additional commands, e-mail: users-help@tapestry.apache.org
>>>
>>>
>>>
>>
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
For additional commands, e-mail: users-help@tapestry.apache.org
Re: tapdoc
Posted by andyhot <an...@di.uoa.gr>.
Henri Dupre wrote:
> Oh this looks very nice!
> Does tapdoc take into account also components with annotations that
> have no
> .jwc?
>
It does... I think it uses a custom doclet to extract javadocs from
those 'annotation-only'
components
>
> On 8/15/06, Norbert Sándor <de...@erinors.com> wrote:
>>
>> Hello,
>>
>> I have converted Tapdoc to Maven2, so it now has a standard website at:
>> http://www.erinors.com/developer/project/tapdoc/
>> The jar and the source code is available from our maven2 repository.
>> You can download a Maven2-based demo application from the website as
>> well.
>>
>> (Please note:
>> - the Maven2 integration is partial, currently the ant-plugin is used to
>> integrate tapdoc to maven-based projects
>> - the source code needs further cleanup)
>>
>> Regards,
>> Norbert Sándor
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
>> For additional commands, e-mail: users-help@tapestry.apache.org
>>
>>
>
>
--
Andreas Andreou - andyhot@apache.org - http://andyhot.di.uoa.gr
Tapestry / Tacos developer
Open Source / J2EE Consulting
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
For additional commands, e-mail: users-help@tapestry.apache.org
Re: tapdoc
Posted by Henri Dupre <he...@gmail.com>.
Oh this looks very nice!
Does tapdoc take into account also components with annotations that have no
.jwc?
On 8/15/06, Norbert Sándor <de...@erinors.com> wrote:
>
> Hello,
>
> I have converted Tapdoc to Maven2, so it now has a standard website at:
> http://www.erinors.com/developer/project/tapdoc/
> The jar and the source code is available from our maven2 repository.
> You can download a Maven2-based demo application from the website as well.
>
> (Please note:
> - the Maven2 integration is partial, currently the ant-plugin is used to
> integrate tapdoc to maven-based projects
> - the source code needs further cleanup)
>
> Regards,
> Norbert Sándor
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
> For additional commands, e-mail: users-help@tapestry.apache.org
>
>
--
Henri Dupre
Actualis Center
Re: tapdoc
Posted by Norbert Sándor <de...@erinors.com>.
Download the demo project, its pom.xml contains a sample configuration
of the ant task.
Regards,
Norbi
Dan Adams wrote:
> Hey, thanks. looks great. is there some docs on the ant plugin at all? i
> want to use it to generate docs to include with the maven site.
>
> On Tue, 2006-08-15 at 15:56 +0200, Norbert Sándor wrote:
>
>> Hello,
>>
>> I have converted Tapdoc to Maven2, so it now has a standard website at:
>> http://www.erinors.com/developer/project/tapdoc/
>> The jar and the source code is available from our maven2 repository.
>> You can download a Maven2-based demo application from the website as well.
>>
>> (Please note:
>> - the Maven2 integration is partial, currently the ant-plugin is used to
>> integrate tapdoc to maven-based projects
>> - the source code needs further cleanup)
>>
>> Regards,
>> Norbert Sándor
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
>> For additional commands, e-mail: users-help@tapestry.apache.org
>>
>>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
For additional commands, e-mail: users-help@tapestry.apache.org
Re: tapdoc
Posted by Dan Adams <da...@ifactory.com>.
Hey, thanks. looks great. is there some docs on the ant plugin at all? i
want to use it to generate docs to include with the maven site.
On Tue, 2006-08-15 at 15:56 +0200, Norbert Sándor wrote:
> Hello,
>
> I have converted Tapdoc to Maven2, so it now has a standard website at:
> http://www.erinors.com/developer/project/tapdoc/
> The jar and the source code is available from our maven2 repository.
> You can download a Maven2-based demo application from the website as well.
>
> (Please note:
> - the Maven2 integration is partial, currently the ant-plugin is used to
> integrate tapdoc to maven-based projects
> - the source code needs further cleanup)
>
> Regards,
> Norbert Sándor
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
> For additional commands, e-mail: users-help@tapestry.apache.org
>
--
Dan Adams
Senior Software Engineer
Interactive Factory
617.235.5857
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
For additional commands, e-mail: users-help@tapestry.apache.org