scriptella-etl/build-docs.xml at master · scriptella/scriptella-etl · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<project name="Scriptella Documentation Build" default="codereports">
    <property file="custom.build.properties"/>
    <property file="build.properties"/>
    <property name="docs.dir" value="${basedir}/build/docs"/>
    <property name="dtd.dest.dir" value="${docs.dir}/dtd"/>
    <property name="javadoc.dest.dir" value="${docs.dir}/api"/>
    <path id="class.path">
        <fileset dir="lib" includes="**/*.jar"/>
    </path>

    <target name="codereports" depends="dtd, javadoc"/>
    <target name="dtd" depends="clean">
        <description>Generates DTD using DTDDoc</description>
        <fail message="DTDDoc is required to build DTD documentation. Set dtddoc.dir property.
        Download DTDDoc 1.1.0 from https://sourceforge.net/projects/dtddoc/files/dtddoc/1.1.0/" unless="dtddoc.dir"/>
        <condition property="no_dtddoc">
            <available file="${dtddoc.dir}"/>
        </condition>
        <fail message="DTDDoc not found in ${dtddoc.dir}" unless="no_dtddoc"/>
        <taskdef name="DTDDoc"
                 classname="DTDDoc.DTDDocTask">
            <classpath>
                <fileset dir="${dtddoc.dir}" includes="*.jar"/>
            </classpath>
        </taskdef>
        <mkdir dir="${dtd.dest.dir}"/>
        <DTDDoc showHiddenTags="true"
                showFixmeTags="false"
                sourceDir="core/src/conf"
                destDir="${dtd.dest.dir}"
                docTitle="DTD Documentation">
            <include name="**/*.dtd"/>
        </DTDDoc>
        <copy todir="${dtd.dest.dir}" flatten="true">
            <fileset dir="${basedir}/core/src/conf" includes="**/*.dtd"/>
        </copy>
    </target>

    <!-- Prefer running Ant under Java 8 so Javadoc matches the frameset layout on scriptella.org. -->
    <target name="javadoc" depends="clean">
        <mkdir dir="${javadoc.dest.dir}"/>
        <javadoc destdir="${javadoc.dest.dir}" failonerror="true"
                 additionalparam="-Xdoclint:none --allow-script-in-comments"
                 use="true" windowtitle="Scriptella API Documentation">
            <classpath refid="class.path"/>
            <classpath path="${ant.jar}"/>
            <packageset dir="core/src/java"/>
            <packageset dir="drivers/src/java"/>
            <packageset dir="tools/src/java"/>
            <doctitle><![CDATA[<h1>Scriptella API Documentation</h1>]]></doctitle>
            <bottom>
                <![CDATA[<i>Copyright &#169; 2006-2026 The <a href="http://scriptella.org">Scriptella Project</a> Team.<br/>Need help with Scriptella integration, migration, or Java performance? Scriptella consulting by <a href="https://pvrlabs.xyz/">PVR Labs</a>.</i>]]></bottom>
        </javadoc>
    </target>

    <target name="clean" unless="noclean">
        <delete dir="${dtd.dest.dir}" failonerror="no"/>
        <delete dir="${javadoc.dest.dir}" failonerror="no"/>
    </target>

</project>