You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tapestry.apache.org by Howard Lewis Ship <hl...@gmail.com> on 2007/02/19 05:20:35 UTC

Component Reference

I've managed to cobble together a Maven plugin for generating
component reference documentation.

Here's what it looks like:

http://tapestry.apache.org/tapestry5/tapestry-core/component-parameters.html

Not bad I think.

I can now say that the intersection of Maven and Javadoc is at least
the 5th circle of hell.

-- 
Howard M. Lewis Ship
TWD Consulting, Inc.
Independent J2EE / Open-Source Java Consultant
Creator and PMC Chair, Apache Tapestry
Creator, Apache HiveMind

Professional Tapestry training, mentoring, support
and project work.  http://howardlewisship.com

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
For additional commands, e-mail: dev-help@tapestry.apache.org


Re: Component Reference

Posted by D&J Gredler <dj...@gmail.com>.
Nice. I actually like it all on the same page, though it could get long if
they end up including examples (my favorite documentation ever is the
one-page Hibernate docs at
http://www.hibernate.org/hib_docs/v3/reference/en/html_single/ ;-).

Random comments:

1. Maybe the headers should be the unqualified component name, i.e. "Any"
instead of "org.apache.tapestry.corelib.components.Any".
2. The headers could stand out a little bit more (see Jesse's previous
comment).
3. The javadoc links aren't included in the descriptions (for example the
links to the three mixins in the AbstractField description).
4. I'm not sure if users will want to know about the AbstractField and
AbstractTextField base classes.
5. Along those same lines, I'm not sure what use there is to the component
inheritance chain if the parameter tables include parameters from
superclasses.

Like I said though, very nice!


On 2/18/07, Jesse Kuhnert <jk...@gmail.com> wrote:
>
> Heh .. Looks pretty good :)
>
> The only thing that really looks like it could be better would be
> possibly not having them all on the same page. It's hard to focus on
> one section otherwise. (or find it)
>
> On 2/18/07, Howard Lewis Ship <hl...@gmail.com> wrote:
> > I've managed to cobble together a Maven plugin for generating
> > component reference documentation.
> >
> > Here's what it looks like:
> >
> >
> http://tapestry.apache.org/tapestry5/tapestry-core/component-parameters.html
> >
> > Not bad I think.
> >
> > I can now say that the intersection of Maven and Javadoc is at least
> > the 5th circle of hell.
> >
> > --
> > Howard M. Lewis Ship
> > TWD Consulting, Inc.
> > Independent J2EE / Open-Source Java Consultant
> > Creator and PMC Chair, Apache Tapestry
> > Creator, Apache HiveMind
> >
> > Professional Tapestry training, mentoring, support
> > and project work.  http://howardlewisship.com
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
> > For additional commands, e-mail: dev-help@tapestry.apache.org
> >
> >
>
>
> --
> Jesse Kuhnert
> Tapestry/Dojo team member/developer
>
> Open source based consulting work centered around
> dojo/tapestry/tacos/hivemind. http://blog.opencomponentry.com
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
> For additional commands, e-mail: dev-help@tapestry.apache.org
>
>

Re: Component Reference

Posted by Jesse Kuhnert <jk...@gmail.com>.
Heh .. Looks pretty good :)

The only thing that really looks like it could be better would be
possibly not having them all on the same page. It's hard to focus on
one section otherwise. (or find it)

On 2/18/07, Howard Lewis Ship <hl...@gmail.com> wrote:
> I've managed to cobble together a Maven plugin for generating
> component reference documentation.
>
> Here's what it looks like:
>
> http://tapestry.apache.org/tapestry5/tapestry-core/component-parameters.html
>
> Not bad I think.
>
> I can now say that the intersection of Maven and Javadoc is at least
> the 5th circle of hell.
>
> --
> Howard M. Lewis Ship
> TWD Consulting, Inc.
> Independent J2EE / Open-Source Java Consultant
> Creator and PMC Chair, Apache Tapestry
> Creator, Apache HiveMind
>
> Professional Tapestry training, mentoring, support
> and project work.  http://howardlewisship.com
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
> For additional commands, e-mail: dev-help@tapestry.apache.org
>
>


-- 
Jesse Kuhnert
Tapestry/Dojo team member/developer

Open source based consulting work centered around
dojo/tapestry/tacos/hivemind. http://blog.opencomponentry.com

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
For additional commands, e-mail: dev-help@tapestry.apache.org