webdoclet

This task executes various web-specific sub-tasks. Make sure to include the jar file containing Sun's javax.servlet.* classes on the taskdef's classpath.

Attributes

Attribute Description Required
excludedTags Specify tags that should not be automatically written to output files. The normal behaviour is to include all @ tags from the source file to the output files. This may cause trouble if you use cvs-like tag like $Revision: 1.5 $ that will be overwritten at each build and causes a difference for CVS even if the code himself is not changed. Example: excludedtags="@ version" For excluded tags, ejbdoclet will generate an hardcoded tag. Example: @ version XDOCLET 1.0 No.
destDir Destination directory for output files No.
mergeDir Directory where subtasks will look for files to be merged with generated files. No, but should be set if you want to use the merge feature.
force Specify if the generation of files should be forced. In normal cases, the timestamp of generated file is checked against the timestamps of the class (and its super classes) we generate from. When this timestamp checking should be bypassed (for example after the installtion of a new xdoclet version) then the user should force the regeneration. The easiest way is to run the Ant build file with a parameter "-Dxdoclet.force=true" and add the option "force=${xdoclet.force}" to the doclet call. No.
verbose Sets the Verbose attribute of the DocletTask object. No.
addedTags Add some JavaDoc tags (or comments) to the generated classes. A special case @ xdoclet-generated. If this is included, ejbdoclet will not consider the file if it is by error in the fileset of the ejbdoclet task. No.

Nested Elements

Element Description
configParam Describe the method
deploymentdescriptor Generates web.xml deployment descriptor.
fileset Ant's <fileset> definition. To define the files to parse.
jbosswebxml Generates jboss-web.xml deployment descriptor.
jonaswebxml Generates the web application deployment descriptor for JOnAS.
jrunwebxml Generates jrun-web.xml deployment descriptor.
jsptaglib Generates taglib.tld deployment descriptor for JSP taglibs.
packageSubstitution Substitutes the package of the generated files.
resin-web-xml Subtask for generation of web.xml with resin extensions.
strutsconfigxml Generates struts-config.xml deployment descriptor.
strutsvalidationxml Generates Struts Validator validation.xml deployment descriptor.
subTask
template Describe the method
weblogicwebxml Generates weblogic.xml deployment descriptor for Web apps.
webspherewebxml This class is responsible for generating the WebSphere specific deployment descriptors.
webworkactiondocs Generates HTML file containing description of defined WebWork actions.
webworkconfigproperties Generates views.properties.
xmlTemplate Describe the method