xdoclet.modules.doc

Class AntdocSubTask

public class AntdocSubTask extends TemplateSubTask

Generates ant docs. Introspects classes and looks for nested elements. Generates one single file for each element. All generated element docs also links nested elements' docs.

Version: $Revision: 1.17 $

Author: Aslak Hellesxy

UNKNOWN: 21. juli 2002 display-name = "Ant documentation" name = "antdocs" parent = "xdoclet.DocletTask" use DocletTask as parent instead. should be enough.

Nested Class Summary
class	AntdocSubTask.Element This class corresponds to an XML element in an Ant build file.
class	AntdocSubTask.SubElement

Field Summary
protected Map	classToAntElementMap Usually, one class corresponds to only one XML element, but in some rare cases it might correspond to more.

Method Summary
protected void	generateForClass(XClass clazz)
String	getDestinationFile()
void	init(XJavaDoc xJavaDoc)
protected boolean	matchesGenerationRules(XClass clazz)
protected boolean	processInnerClasses()
void	validateOptions()

Field Detail

classToAntElementMap

protected final Map classToAntElementMap

Usually, one class corresponds to only one XML element, but in some rare cases it might correspond to more. This is if the same class is used in e.g. several create methods: Gee createFoo(), Gee createBar()

The Gee class corresponds to <foo> AND <bar>. This map's values are Sets containing AntElements.