ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sbaill...@apache.org
Subject cvs commit: jakarta-ant/src/main/org/apache/tools/ant/types Description.java
Date Wed, 08 Aug 2001 20:18:34 GMT
sbailliez    01/08/08 13:18:34

  Added:       docs/manual/CoreTasks description.html
               src/main/org/apache/tools/ant/types Description.java
  Log:
  Convenient description task that allows a multiple line description of a buildfile
  with a <description> element.
  Submitted by Craeg K. Strong <cstrong@arielpartners.com>
  
  Not committed in the first shot..er..forgot to add them.
  Thank to Craeg for paying attention.
  
  Revision  Changes    Path
  1.1                  jakarta-ant/docs/manual/CoreTasks/description.html
  
  Index: description.html
  ===================================================================
  <html>
  
  <head>
  <meta http-equiv="Content-Language" content="en-us">
  <title>Ant User Manual</title>
  </head>
  
  <body>
  
  <h2><a name="description">Description</a></h2>
  <h3>Description</h3>
  <p>Provides a description of the current project.</p>
  <h3>Parameters</h3>
  <p>(none)</p>
  <h3>Examples</h3>
  <pre>  
  &lt;description&gt;
  This buildfile is used to build the foo subproject within 
  the large, complex bar project.
  &lt;/description&gt;
  </pre>
  <hr>
  <p align="center">Copyright &copy; 2000,2001 Apache Software Foundation. All rights
  Reserved.</p>
  
  </body>
  </html>
  
  
  
  
  1.1                  jakarta-ant/src/main/org/apache/tools/ant/types/Description.java
  
  Index: Description.java
  ===================================================================
  /*
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2000 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Ant", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  
  package org.apache.tools.ant.types;
  
  import org.apache.tools.ant.Project;
  
  /**
   * 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.
   *
   * @author <a href="mailto:cstrong@arielpartners.com">Craeg Strong</a>
   * @version $Revision: 1.1 $ $Date: 2001/08/08 20:18:34 $
   */
  public class Description extends DataType {
     
     private Project project;
     
     public Description(Project project) {
        this.project = project;
     }
  
      /**
       * Adds descriptive text to the project.
       */
     public void addText(String text) {
        project.setDescription(text);
     }
  }
  
  
  

Mime
View raw message