<!--
Build include file for the GridSphere Portal source code, see build.xml

 - $Id: build-docs.xml 4496 2006-02-08 20:27:04Z wehrens $

-->


<project name="GridSphere documentation">

    <!-- Generates the documentation. Include file to build.xm -->

    <target name="answer-docs" description="Check whether to create GridSphere Documentation" if="install.docs">
        <antcall target="docs"/>
    </target>

    <target name="docs" depends="javadoc" description="Create GridSphere Documentation"/>

    <target name="check-javadocs">
        <condition property="javadocs.exists">
            <available file="${build.javadoc}/index.html"/>
        </condition>
    </target>

    <!-- =================================================================== -->
    <!-- Creates all the API documentation                                   -->
    <!-- =================================================================== -->
    <target name="javadoc" depends="setenv, check-javadocs" description="Create GridSphere Javadocs" unless="javadocs.exists">
        <mkdir dir="${build.javadoc}"/>
        <javadoc packagenames="org.gridlab.gridsphere.*, javax.*"
            sourcepath="src"
            classpathref="classpath"
            destdir="${build.javadoc}"
            author="true"
            version="true"
            splitindex="true"
            use="true"
            breakiterator="true"
            maxmemory="256m"
            windowtitle="${gridsphere.name}"
            doctitle="${gridsphere.api}"
            bottom="Copyright &#169; 2002,2003,2004 GridSphere Project. All Rights Reserved.">

            <!-- <link href="http://java.sun.com/j2se/1.4.2/docs/api/"/>

            <link href="http://jakarta.apache.org/log4j/docs/api/"/>

            <link href="http://www.junit.org/junit/javadoc/3.8/index.htm"/>  -->

            <group title="GridSphere Framework API"
                packages="org.gridlab.gridsphere:org.gridlab.gridsphere.*"/>

            <group title="GridSphere Portlet API"
                packages="org.gridlab.gridsphere.event:org.gridlab.gridsphere.event.*,
                          org.gridlab.gridsphere.portlet:org.gridlab.gridsphere.portlet.*,
                          org.gridlab.gridsphere.portlet.service:org.gridlab.gridsphere.portlet.service.*,
                          org.gridlab.gridsphere.portlet.service.spi:org.gridlab.gridsphere.portlet.service.spi.*"/>

            <group title="JSR 168 Portlet API"
                packages="javax.portlet:javax.portlet.*"/>

            <group title="GridSphere Portlet API Implementation"
                packages="org.gridlab.gridsphere.event.impl:org.gridlab.gridsphere.event.impl.*,
                          org.gridlab.gridsphere.portlet.impl:org.gridlab.gridsphere.portlet.impl.*,
                          org.gridlab.gridsphere.portlet.service.impl:org.gridlab.gridsphere.portlet.service.impl.*,
                          org.gridlab.gridsphere.portlet.service.spi.impl:org.gridlab.gridsphere.portlet.service.spi.impl.*"/>

            <group title="GridSphere JSR 168 Portlet API Implementation"
                packages="org.gridlab.gridsphere.portlet.jsrimpl:org.gridlab.gridsphere.portlet.jsrimpl.*"/>

            <group title="GridSphere Portal Component Library"
                packages="org.gridlab.gridsphere.layout:org.gridlab.gridsphere.layout.*"/>

            <group title="GridSphere UI Tag Library"
                packages="org.gridlab.gridsphere.tags:org.gridlab.gridsphere.tags.*"/>

            <group title="GridSphere Portlet Service Library"
                packages="org.gridlab.gridsphere.services:org.gridlab.gridsphere.services.*"/>

            <group title="GridSphere Portlets"
                packages="org.gridlab.gridsphere.portlets:org.gridlab.gridsphere.portlets.*"/>

        </javadoc>
    </target>

</project>
