cocoon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Bernhard Huber <berni_hu...@a1.net>
Subject cocoon sitemap reference pages
Date Sun, 13 Jan 2002 11:02:23 GMT
Hi,

The last day I was trying to auto-generate sitemap reference documentation.

I was implementing a java1.3 doclet extension. This doclet extension uses
Velocity to generate apache document pages for
* Generator
* Transformer
* Serializer
classes.

Each of this classes generates following document elements:
<s2 title="{FQN classname}">
  {first sentence of class javadoc}
  Name {optional @cocoon:name javadoc tag}
  Class {FQN classname}
  Cacheable {true if class implements Cacheable}
  AllInterfaces {list of all implementing interfaces}
  AllSuperclasses {list of all superclasses}

  <s3 title="Sitemap Definition">
    <source>
       ... <map:generator name="{@cocoon:name}" src="{FQN classname}"/> ...
    </source>
  </s3>
  <s3 title="Sitemap Usage">
    ... <map:generate name="{@cocoon:name}"/>...
  </s3>
</s2>

As of today some javadocs has html tags in the javadoc which makes troubles
in the "build docs" document generation.

This effort might help to have uptodate documentation, as it is 
generated directly from the
java source code.
This effort does not replace writting documentation, but it might help.

Currently only the javadoc tag @cocoon:name is respected.
Maybe defining more tags might enrich the reference documents further.

The reference documentation step should happen before launching "build 
docs".
The files generators-ref.xml, transformers-ref.xml, and 
serializers-ref.xml are generated
by the reference documetation step.

Any ideas?

bye bernhard



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


Mime
View raw message