ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ehatc...@apache.org
Subject cvs commit: jakarta-ant/proposal/xdocs/src/org/apache/tools/ant/taskdefs Test.java
Date Wed, 27 Feb 2002 05:26:41 GMT
ehatcher    02/02/26 21:26:41

  Added:       proposal/xdocs/lib LICENSE.xdoclet.txt xdoclet.jar
               proposal/xdocs/templates task_xdoc.template
               proposal/xdocs/src/org/apache/tools/ant/taskdefs Test.java
  Log:
  First pass at XDoclet generation of Ant task documentation.
  (sorry for the multiple commits, still getting a lock error on big commit attempts)
  
  Revision  Changes    Path
  1.1                  jakarta-ant/proposal/xdocs/lib/LICENSE.xdoclet.txt
  
  Index: LICENSE.xdoclet.txt
  ===================================================================
   Copyright (c) 2000-2002, XDoclet team
   All rights reserved.
  
   Redistribution and use in source and binary forms, with or without modification, 
   are permitted provided that the following conditions are met:
  
   Redistributions of source code must retain the above copyright notice, this list 
   of conditions and the following disclaimer.
  
   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.
  
   Neither the name of the XDoclet team nor the names of its contributors may be used 
   to endorse or promote products derived from this software without specific prior
   written permission.
  
   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND ANY 
   EXPRESS 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 REGENTS OR 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.
  
  
  1.1                  jakarta-ant/proposal/xdocs/lib/xdoclet.jar
  
  	<<Binary file>>
  
  
  1.1                  jakarta-ant/proposal/xdocs/templates/task_xdoc.template
  
  Index: task_xdoc.template
  ===================================================================
  <XDtTagDef:tagDef namespace="Ant" handler="org.apache.tools.ant.xdoclet.AntTagsHandler"/>
  
  <task name="<XDtAnt:taskName/>" classname="<XDtClass:fullClassName/>">
  
    <short-description><![CDATA[<XDtClass:firstSentenceDescription/>]]></short-description>
    <long-description>
      <![CDATA[<XDtClass:classComment no-comment-signs="true"/>]]>
    </long-description>
  
    <structure>
  
      <XDtAnt:forAllAttributes>
        <attribute name="<XDtMethod:propertyName/>" type="<XDtParameter:forAllMethodParams><XDtParameter:methodParamType/></XDtParameter:forAllMethodParams>">
          <description><![CDATA[
            <XDtMethod:methodComment no-comment-signs="true"/>
          ]]></description>
        </attribute>
      </XDtAnt:forAllAttributes>
  
      <XDtAnt:forAllElements>
        <element name="<XDtAnt:elementName/>">
          <description><![CDATA[
            <XDtMethod:methodComment no-comment-signs="true"/>
          ]]></description>
        </element>
      </XDtAnt:forAllElements>
  
      <!-- @todo: wrap setCurrentMethod inside AntTagsHandler -->
      <XDtMethod:setCurrentMethod name="addText" parameters="java.lang.String">
        <body>
          <description><![CDATA[
            <XDtMethod:methodComment no-comment-signs="true"/>
          ]]></description>
        </body>
      </XDtMethod:setCurrentMethod>
  
    </structure>
  
      <!-- merge point for samples? -->
  </task>
  
  
  
  
  
  1.1                  jakarta-ant/proposal/xdocs/src/org/apache/tools/ant/taskdefs/Test.java
  
  Index: Test.java
  ===================================================================
  /*
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2002 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.taskdefs;
  
  import org.apache.tools.ant.Task;
  
  /**
   * @ant:task name="test"
   */
  public class Test {
      private String value;
      
      public void setValue (String value) {
          this.value = value;
      }
  }
  
  
  

--
To unsubscribe, e-mail:   <mailto:ant-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:ant-dev-help@jakarta.apache.org>


Mime
View raw message