David Crossley wrote:
Bertrand Delacretaz wrote:I just used "SitemapModelComponent" as something of a throwaway comment, actually, if you search for
David Crossley a ?crit :
...Using the grep javadocs method does not find anyWhy, can't you grep their base interfaces like:
serializers, actions, matchers, selectors.
for i in $(egrep -rl 'SitemapModelComponent|OtherBaseInterface|Other)
?
Oh, i haven't tried that. I expected all sitemap components to have
SitemapModelComponent, but evidently not.
http://cocoon.apache.org/2.1/apidocs/org/apache/cocoon/generation/Generator.html,
http://cocoon.apache.org/2.1/apidocs/org/apache/cocoon/transformation/Transformer.html, etc, in the Javadoc files, you _will_ get everything!
Yup, once marked up, we'll be there. But a simple script we can run everyso often to ensure that we haven't added new ones without markup would be useful.Also, how about defining a marker interface for components that need to be documented in this way? AutoDocumentedComponent extends Component or something like this.
At the moment i am trying to get a list of all possible sitemap components, so that we know which components should be documented.
When we know that, then we can add such a marker to the
relevant components. Actually the SitemapTask will handle that
because it searches for the javadoc-like comments, e.g.
@cocoon.sitemap.component.name
http://cocoon.apache.org/2.1/plan/review-sitemap-docs.html#Introduction
Regards, Upayavira
