JdbcMapper/system-controls/ant/javadoc.xml

<?xml version="1.0"?>
<!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at
   
       http://www.apache.org/licenses/LICENSE-2.0
   
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
  
   $Header:$
-->

<project name="Beehive/SystemControls/Documentation" default="usage" basedir=".">

    <import file="../systemcontrols-imports.xml"/>

    <property name="docs.build.dir" value="${build.dir}/docs"/>

    <available file="${build.lib.dir}" type="dir" property="resources.present"/>

    <path id="javadoc.classpath">
        <fileset dir="${build.lib.dir}" includes="*.jar"/>
        <pathelement path="${classes.dir}/ejb-control-xbean"/>
        <path refid="commons-codec.dependency.path"/>
        <path refid="axis.dependency.path"/>
        <path refid="jaxrpc.dependency.path"/>
        <path refid="saaj.dependency.path"/>
        <path refid="wsdl4j.dependency.path"/>
        <path refid="ejb.dependency.path"/>
        <path refid="xbean.dependency.path"/>
        <path refid="commons-logging.dependency.path"/>
        <path refid="servlet.dependency.path"/>
        <path refid="controls.dependency.path"/>
        <path refid="velocity.dependency.path"/>
        <path refid="tools.dependency.path"/>
        <path refid="ant-jar.dependency.path"/>
    </path>
        
    <target name="build" description="Generates Javadoc for all classes.">
        <antcall target="clean"/>
        <antcall target="generate-class-ref"/>
        <fixcrlf srcDir="${build.dir}/docs" includes="**/*.html"/>
    </target>
    
    <target name="clean">
        <delete dir="${build.dir}/docs" failonerror="false"/>
    </target>
    
    <target name="generate-class-ref">
        <_javadoc controlname="jdbc" displayname="JDBC">
            <source-files>
                <packageset dir="${src.dir}/jdbc">
                    <exclude name="org/apache/beehive/controls/system/jdbc/parser/**"/>
                </packageset>
            </source-files>
        </_javadoc>
        <_javadoc controlname="ejb" displayname="EJB">
            <source-files>
                <packageset dir="${src.dir}/ejb">
                    <exclude name="org/apache/beehive/controls/system/ejb/internal/**"/>
                </packageset>
            </source-files>
        </_javadoc>
        <_javadoc controlname="jms" displayname="JMS">
            <source-files>
                <packageset dir="${src.dir}/jms">
                    <exclude name="org/apache/beehive/controls/system/jms/impl/**"/>
                    <exclude name="org/apache/beehive/controls/system/jndi/**"/>
                </packageset>
            </source-files>
        </_javadoc>
        <_javadoc controlname="wsc" displayname="Web Service Control">
            <source-files>
                <packageset dir="${src.dir}/webservice/control">
                </packageset>
                <packageset dir="${src.dir}/webservice/jaxrpc-clients/axis">
                </packageset>
            </source-files>
        </_javadoc>
    </target>
    
    <!-- The 'use' attribute is currently set to 'false' because of Java bug 5055723.
         This bug will be fixed for the general release of JDK5.
         Track the bug at: http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=5055723
         When the fix arrives in JDK5, set use="true". 
      -->
    <macrodef name="_javadoc">
        <attribute name="controlname" description="The name of the control to Javadoc"/>
        <attribute name="displayname" description="The display name of the Javadoc'ed control"/>
        <element name="source-files"/>
        <sequential>
            <javadoc destdir="${build.dir}/docs/@{controlname}/apidocs"
                     maxmemory="256M" 
                     windowtitle="Apache Beehive @{displayname} Controls API Documentation (Version ${beehive.version})" 
                     doctitle="Apache Beehive @{displayname} Controls API Documentation (Version ${beehive.version})" 
                     version="true"
                     author="false"  
                     use="false" 
                     additionalparam="-breakiterator -noqualifier all -notimestamp"
                     useexternalfile="true" 
                     classpathref="javadoc.classpath" 
                     source="1.5">
                <source-files/>
            </javadoc>
        </sequential>
    </macrodef>
	
    <target name="usage">
        <echo message="================================================================================"/>
        <echo message="|                                  Usage                                       |"/>
        <echo message="================================================================================"/>
        <echo message="build - Cleans and builds all doc, copies the result to the forrest site.    "/>
        <echo message="clean - Deletes the built netui docs and associated temp files."/>
        <echo message="generate-class-ref - Generates the Page Flow class reference, using the standard Javadoc doclet."/>
        <echo message="================================================================================"/>
        <echo message="|                                                                              |"/>
        <echo message="================================================================================"/>
    </target>

</project>