Package org.apache.tools.ant.types
Class Description
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.Description
- All Implemented Interfaces:
- Cloneable
Description is used to provide a project-wide description element
 (that is, a description that applies to a buildfile as a whole).
 If present, the <description> element is printed out before the
 target descriptions.
 Description has no attributes, only text.  There can only be one
 project description per project.  A second description element will
 overwrite the first.
- 
Field SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidAdds descriptive text to the project.static StringgetDescription(Project project) Return the descriptions from all the targets of a project.Methods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toStringMethods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
- 
Constructor Details- 
Descriptionpublic Description()
 
- 
- 
Method Details- 
addTextAdds descriptive text to the project.- Parameters:
- text- the descriptive text
 
- 
getDescriptionReturn the descriptions from all the targets of a project.- Parameters:
- project- the project to get the descriptions for.
- Returns:
- a string containing the concatenated descriptions of the targets.
 
 
-