Component ReportPage edited by Igor DrobiazkoChanges (2)
Full ContentThe Component Report module lets you generate comprehensive documentation for all the components in your module (either a component library or a Tapestry application). For each component, the inheritance, description and complete set of parameters (including inherited parameters) are displayed. The documentation is generated from a mix of JavaDoc and annotations on the classes themselves, and from external documentation you may provide. External DocumentationThe external documentation is optional, and takes the form of a file, stored in the same package as the component class, with the extension ".xdoc". External documentation is in the Maven XDoc Format, which can be thought of as a somewhat rigid, stripped down version of XHTML. The component report will extract the content of the <body> element and add it to the documentation it automatically generates. It will also copy any images (the src attribute of any <img> element) to the corresponding output folder. The documentation is generated into a directory structure that mimics the package structure; thus a link to component documentation for components in the same package is just a link to another file (with a .html extension) in the same folder. Example: <document> <body> <section name="Related Components"> <ul> <li><a href="" class="code-quote">"Foo.html">Foo</a></ul> <li><a href="" class="code-quote">"Bar.html">Bar</a></ul> </ul> </section> <section name="Examples"> <p>The Baz component can be used to generate a gloop style of interface:</p> <p><img src="" class="code-quote">"baz_ref.png"/></p> . . .
Change Notification Preferences
View Online
|
View Changes
|