java-common-lib/build/build-documentation.xml at 79888854a505df8af0679edb7252d2740fb36ed9 · sosy-lab/java-common-lib · 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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
<?xml version="1.0" encoding="UTF-8"?>

<!--
This file is part of SoSy-Lab Java-Project Template,
a collection of common files and build definitions for Java projects:
https://gitlab.com/sosy-lab/software/java-project-template

SPDX-FileCopyrightText: 2018-2020 Dirk Beyer <https://www.sosy-lab.org>

SPDX-License-Identifier: Apache-2.0
-->

<!-- vim: set tabstop=8 shiftwidth=4 expandtab filetype=ant : -->
<project name="documentation" basedir=".">

    <!-- Targets for building documentation. -->

    <!-- DO NOT EDIT LOCALLY!
         Keep this file synchronized with
         https://gitlab.com/sosy-lab/software/java-project-template
    -->

    <!-- These properties can be overridden from including file. -->
    <property name="documentation.options.file" value="${class.dir}/org/sosy_lab/${package}/ConfigurationOptions.txt"/>
    <property name="documentation.javadoc.dir" value="Javadoc"/>
    <property name="documentation.javadoc.exclude" value=""/>
    <property name="javadoc.doclint" value="-Xdoclint:all,-missing"/>

    <target name="collect-options" depends="build-project">
        <echo message="running OptionCollector..." level="info"/>

        <java classname="org.sosy_lab.common.configuration.OptionCollector"
            fork="true"
            output="${documentation.options.file}" append="false"
            failonerror="true"
            logError="true">

            <classpath refid="classpath"/>

            <!-- "-v" is a optional param for verbose output of OptionCollector -->
            <!-- <arg value="-v"/> -->
        </java>
        <echo message="Options collected." level="info"/>
    </target>

    <target name="javadoc" depends="build-project">
        <javadoc
            destdir="${documentation.javadoc.dir}"
            classpathref="classpath"
            locale="en_US"
            encoding="utf-8"
            windowtitle="${ant.project.name}"
            failonerror="true"
            failonwarning="true"
            overview="doc/javadoc_overview.html"
            >

            <fileset dir="${source.dir}">
                <include name="**/*.java"/>
                <exclude name="**/*Test.java"/>
                <exclude name="${documentation.javadoc.exclude}"/>
            </fileset>
            <link href="https://docs.oracle.com/en/java/javase/17/docs/api/"/>
            <link href="https://guava.dev/releases/snapshot/api/docs/"/>
            <link href="https://truth.dev/api/latest/"/>
            <link href="https://sosy-lab.github.io/java-common-lib/api/"/>
            <doctitle><![CDATA[<h1>${ant.project.name}</h1>]]></doctitle>
            <tag name="apiNote" description="API Note:"/>
            <tag name="implSpec" description="Implementation Requirements:"/>
            <tag name="implNote" description="Implementation Note:"/>
            <arg line="${javadoc.doclint}"/>
        </javadoc>
    </target>

    <target name="javadoc-jar" depends="javadoc,determine-version,build" description="Pack Javadoc into a JAR">
        <property name="javadoc-jar.file" value="${ivy.module}-${version}-javadoc.jar"/>
        <jar jarfile="${javadoc-jar.file}">
            <metainf dir="." includes="LICENSE"/>
            <fileset dir="Javadoc" />
        </jar>
    </target>
</project>