You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tapestry.apache.org by "Howard M. Lewis Ship (JIRA)" <ji...@apache.org> on 2011/05/18 21:22:47 UTC

[jira] [Commented] (TAP5-1528) Tapestry-specific JavaDoc plugin that generates parameter documentation, etc.

    [ https://issues.apache.org/jira/browse/TAP5-1528?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13035599#comment-13035599 ] 

Howard M. Lewis Ship commented on TAP5-1528:
--------------------------------------------

The bastards who wrote the standard JavaDoc plugin made it impossible to extend.  I think they are so brain-dead that they didn't realize it, they simply don't understand abstraction.  It may be necessary to require a @tapestrydoc tag in components in order to generate the documentation.

> Tapestry-specific JavaDoc plugin that generates parameter documentation, etc.
> -----------------------------------------------------------------------------
>
>                 Key: TAP5-1528
>                 URL: https://issues.apache.org/jira/browse/TAP5-1528
>             Project: Tapestry 5
>          Issue Type: New Feature
>          Components: tapestry-core
>    Affects Versions: 5.3.0
>            Reporter: Howard M. Lewis Ship
>            Assignee: Howard M. Lewis Ship
>
> Having a split between the JavaDoc and the Component Reference has always been a challenge.  It would be nicer to just have JavaDoc that is extended with Tapestry-specific content on component classes, such as examples (from the optional .xdoc file) and parameter/etc. documentation.   This is further driven by the switch to a Gradle build, as the existing module for generating the Component Reference is Maven specific.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira