JellyDoc generates documentation for Jelly tag libraries from their javadoc. An example of JellyDoc generated content can be viewed here.
This document is a brief (and non-normative) guide written by developers using JellyDoc to document their tag libraries and is aimed at helping developers use JellyDoc. Please help to improve this resource by contributing patches.
Note that this document is based on the maven build script used by the Apache Commons Jelly build. Details may vary for other builds.
The content generated by JellyDoc can be divided into different sections. These sections are then arranged into the document presented to the user. Understanding where each of these sections comes from is key to writing javadocs for tag libraries aimed at use by JellyDoc.
This is not strictly part of the main JellyDoc generated document but it is related (and this seems like a good place to discuss it). This appears in the generated overview document as the content paragraph.
This is taken from the
<description> tag in the
for the tag library.
This appears in the main generated JellyDoc content as the description associated with the library in the library table and also within the descriptive subsection below.
This is the contents of the body of the
package.html file for the package
containing the tag library.
This appears in the main generated JellyDoc content as the description associated with the tag in the tags table and also within the descriptive subsection for the tag.
This is the contents of the class level javadocs for the class implementing the class.
This appears in the main generated JellyDoc content as the description associated with the attribute in the tag attributes table.
This is the contents of the javadocs for the setter property mapped to the attribute.
Note that this includes the contents of the
@return tag and so care
is needed to ensure that the generated output scans.