build/build-docs.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
  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.
-->


<project name="Cloud Stack Document Tasks" default="help" basedir=".">
  <description>
		Cloud Stack ant build file
  </description>

  <!--
 	Always use this variable to refer to the base directory because this
	variable is changeable
    -->
  <dirname property="base.dir" file="${ant.file.Cloud Stack Document Tasks}/.." />
  
  <import file="./build-cloud.xml" optional="false"/>
  
  <!-- directories for java doc -->
  <property name="docs.dir" location="${target.dir}/docs" />
  <property name="docs.dist.dir" location="${dist.dir}/docs" />

  <target name="doc" depends="-init, javadoc, readme" description="create all javadoc" />

  <target name="readme" depends="-init">
    <mkdir dir="${docs.dir}/readme" />
    <copy file="${agent.dir}/scripts/README.txt" todir="${docs.dir}/readme" />
  </target>

  <target name="pdf" depends="-init">
    <javadoc doclet="com.tarsec.javadoc.pdfdoclet.PDFDoclet" docletpath="${tools.dir}/pdfdoclet/pdfdoclet-1.0.2-all.jar" overview="${build.dir}/overview.html" additionalparam="-pdf javadoc.pdf -debug" private="no" access="public" classpathref="deps.classpath" linksource="true" sourcepathref="prod.src.path">
      <!--
            <taglet name="net.sourceforge.taglets.Taglets" path="${tools.dir}/taglets/taglets.jar"/>
            <tag name="config" description="Configurable Parameters in components.xml" scope="types"/>
            <tag name="see" />
            <tag name="author" />
            <tag name="since" />
            -->
      <!--<packages>com.cloud.agent</packages-->
      <!--package name="com.cloud.agent"/-->
      <packageset dir="${server.dir}/src" />
    </javadoc>
  </target>

  <target name="javadoc" depends="-init, build-all" description="Generate internal javadoc documentation for maintenance">
    <!-- documentation properties -->
    <property name="jdoc.footer" value="Copyright &amp;copy; ${company.copyright.year} ${company.name}" />

    <javadoc destdir="${docs.dir}/html/api-internal" author="true" version="true" classpathref="deps.classpath" sourcepathref="prod.src.path" access="protected" linksource="true" windowtitle="${company.name} ${version} Maintenance API Reference" doctitle="${company.name} ${version} Maintenance API Reference" bottom="${jdoc.footer}" overview="${build.dir}/overview.html">
      <excludepackage name="com.xensource.xenapi.*" />
      <taglet name="net.sourceforge.taglets.Taglets" path="${tools.dir}/taglets/taglets.jar" />
      <tag name="config" description="Configurable Parameters in components.xml" scope="types" />
      <tag name="see" />
      <tag name="author" />
      <tag name="since" />
      <packageset dir="${server.dir}/src" />
    </javadoc>
  </target>

  <target name="build-docs" depends="javadoc">
    <copy todir="${docs.dist.dir}">
      <fileset dir="${docs.dir}" />
    </copy>
  </target>

</project>