Class Description

  • All Implemented Interfaces:
    java.lang.Cloneable

    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.
    • Constructor Detail

      • Description

        public Description()
    • Method Detail

      • addText

        public void addText​(java.lang.String text)
        Adds descriptive text to the project.
        Parameters:
        text - the descriptive text
      • getDescription

        public static java.lang.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.