org.apache.tools.ant.types

Class Description


public class Description
extends DataType

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.

Version:
$Revision: 1.15.2.4 $ $Date: 2004/03/09 17:01:54 $

Field Summary

Fields inherited from class org.apache.tools.ant.types.DataType

checked, description, ref

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Method Summary

void
addText(String text)
Adds descriptive text to the project.
static String
getDescription(Project project)
return the descriptions from all the targets of a project.

Methods inherited from class org.apache.tools.ant.types.DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, getCheckedRef, getDescription, getRefid, isChecked, isReference, noChildrenAllowed, setChecked, setDescription, setRefid, tooManyAttributes

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Method Details

addText

public void addText(String text)
Adds descriptive text to the project.

Parameters:
text - the descriptive text


getDescription

public static String getDescription(Project project)
return 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.


Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.