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
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.
-->
<!DOCTYPE someant [
<!ENTITY links SYSTEM "links.xml">
<!ENTITY links8 SYSTEM "links8.xml">
<!ENTITY links11 SYSTEM "links11.xml">
<!ENTITY properties SYSTEM "properties.xml">
<!ENTITY replacesjdk SYSTEM "replacesjdk.xml">
<!ENTITY replaces SYSTEM "replaces.xml">
<!ENTITY disallowed-links SYSTEM "disallowed-links.xml">
]>
------------------------------ javadoc ------------------------
${javadoc.base} top dir of module, e.g. "${nb_all}/foo" ("." from your build script)
${javadoc.name} name of docs folder, e.g. "org-netbeans-modules-foo"
${javadoc.title} display title of docs, e.g. "Foo API"
${javadoc.packages} list of packages to build, e.g. "org.netbeans.api.foo,org.netbeans.spi.foo"
${javadoc.classpath} classpath for source files (probably same as what you use for <javac>)
Optional:
${javadoc.files} selector describing which files to build
${javadoc.main.page} link to main page, e.g. org/netbeans/api/foo/doc-files/api.html
${javadoc.docfiles} doc-files directory such as ${javadoc.base}/api/doc; default none
${javadoc.apichanges} API change list XML file; default no change list
${javadoc.arch} architecture summary of the module; default a dummy summary
${javadoc.overview} Overview HTML file; default a generic page
${javadoc.check.external.links} set to "true" to check external HTTP links
${javadoc.header} Special header text.
${javadoc.web.root} Base URL for online Javadoc for linking; default http://www.netbeans.org/download/dev/javadoc
To call this script you MUST use the form of <ant> with the 'dir' attribute. This script expects that its basedir is the directory containing it. If you use only
the 'antfile' attribute the basedir will be copied from your script, which will
cause it to fail.
]]></description>
<target name="die">
<fail>Use this script only from other scripts, to call templated targets.</fail>
</target>
<!-- set the property for use in this script -->
<property name="javadoc.docs.${javadoc.name}" value="${javadoc.web.root}/${javadoc.name}" />
</target>
<target name="javadoc-stage-alternative" depends="javadoc-init,javadoc-check-timestamps" if="javadoc.should.not.be.generated" unless="javadoc.up.to.date" > <!-- if no packages are specified, this is used to generate index.html from the overview page -->
<copy file="${javadoc.overview}" tofile="${javadoc.out.dir}/index.html" />
</target>
<target name="-javadoc-set-footer"> <!-- Timestamp is handled in javadoc.css to avoid too many commits on generated HTML files. -->
<property name="javadoc.footer" value='<span class="footnote"></span><!-- See javadoc.css for timestamp information -->'/>
</target>
<condition property="apidoc.check" value="true" else="false">
<isset property="apidocfullcheck"/> <!-- CI parameter --> <!-- fail on error and warning as error means no javadoc content and missing page on bits.netbeans.org -->
</condition>
<target name="javadoc-exec-packages" depends="javadoc-init,javadoc-generate-references,javadoc-generate-overview,javadoc-exec-condition,javadoc-check-timestamps,javadoc-make-plain-title,javadoc-make-hyperlinked-title,javadoc-exec-condition,-javadoc-set-footer" unless="javadoc.exec.packages">
<javadoc source="${javac.sourcerelease}" failonerror="${apidoc.check}" failonwarning="false" author="false" destdir="${javadoc.out.dir}" packagenames="${javadoc.packages}" stylesheetfile="${javadoc.css.main}" windowtitle="${javadoc.title}" overview="${javadoc.overview}" splitindex="true" use="true"version="false" useexternalfile="true"encoding="UTF-8">
<sourcepath>
<pathelement location="${javadoc.docfiles}"/>
<pathelement location="${javadoc.src}"/>
<pathelement location="${javadoc.src}/../build/classes-generated"/>
</sourcepath>
<classpath path="${javadoc.classpath}"/> <!-- XXX note, this does not support more than one group -->
<group packages="${javadoc.packages}">
<title>${javadoc.hyperlinked.title}</title>
</group> <!-- jdk 8 backward -->
&links8; <!-- jdk modular apidoc -->
&links11; <!-- other links -->
&links;
<doctitle>${javadoc.title}<br/>${javadoc.stability.label}</doctitle>
<header>${javadoc.header}</header>
<bottom>${javadoc.footer}</bottom> <!-- Avoid timestamp comments in _all_ html generated files, to reduce unnecessary git commits -->
<arg value="-notimestamp" />
<arg value="-Xdoclint:all" />
<arg value="-Xdoclint:-missing" />
<arg value="--allow-script-in-comments" if:true="${javadoc23.or.later}" />
<arg value="--snippet-path ${javadoc.base}/test/unit/src:${javadoc.base}/src" if:true="${javadoc23.or.later}" />
<arg value="--no-fonts" if:true="${javadoc23.or.later}" />
<arg value="--syntax-highlight" if:true="${javadoc25.or.later}" />
</javadoc>
</target>
<target name="javadoc-exec-files" depends="javadoc-init,javadoc-generate-references,javadoc-generate-overview,javadoc-exec-condition,javadoc-check-timestamps,javadoc-make-plain-title,javadoc-make-hyperlinked-title" if="javadoc.files.provided,-javadoc-set-footer" unless="javadoc.up.to.date">
<javadoc source="${javac.sourcerelease}" author="false" destdir="${javadoc.out.dir}"packagenames="${javadoc.packages}" stylesheetfile="${javadoc.css.main}" windowtitle="${javadoc.title}" overview="${javadoc.overview}" splitindex="true" use="true"version="false" useexternalfile="true"encoding="UTF-8">
<fileset dir="${javadoc.docfiles}"/>
<fileset dir="${javadoc.src}" >
<and>
<selector refid="${javadoc.files}" />
<filename name="**/*.java" />
</and>
</fileset>
<classpath path="${javadoc.classpath}"/> <!-- XXX note, this does not support more than one group -->
<group packages="${javadoc.packages}">
<title>${javadoc.hyperlinked.title}</title>
</group> <!-- jdk 8 backward -->
&links8; <!-- jdk modular apidoc -->
&links11; <!-- other links -->
&links;
<doctitle>${javadoc.title}<br/>${javadoc.stability.label}</doctitle>
<header>${javadoc.header}</header>
<bottom>${javadoc.footer}</bottom>
<arg value="-Xdoclint:all" />
<arg value="-Xdoclint:-missing" />
</javadoc>
</target>
<target name="javadoc-stage-export-apichanges" depends="javadoc-init,javadoc-check-timestamps,javadoc-stage-init-apichanges" unless="javadoc.apichanges.should.not.be.generated">
<fail message="Need to specify the date of branching of previous.release.year: ${previous.release.year}" unless="previous.release.year" />
<fail message="Need to specify the date of branching of previous.release.month: ${previous.release.month}" unless="previous.release.month" />
<fail message="Need to specify the date of branching of previous.release.day: ${previous.release.day}" unless="previous.release.day" />
<target name="javadoc-stage-replace" depends="javadoc-stage-main,javadoc-generate-references,javadoc-stage-alternative,javadoc-stage-apichanges,javadoc-stage-arch,javadoc-stage-export-interfaces,javadoc-stage-replace-interfaces,javadoc-stage-replace-apichanges" unless="javadoc.up.to.date"> <!-- need to cleanup href for allclasses as starting jdk21 javadoc this file take also description -->
<replaceregexp match="href=".*\@org" replace="href="\@org" flags="g" >
<fileset dir="${javadoc.out.dir}" includes="allclasses-index.html"/>
</replaceregexp>
<target name="javadoc-stage-check" depends="javadoc-stage-replace" unless="javadoc.up.to.date">
<taskdef name="checklinks" classname="org.netbeans.nbbuild.CheckLinks">
<classpath>
<pathelement location="${nbantext.jar}"/>
</classpath>
</taskdef>
<checklinks basedir="${javadoc.out.dir}" checkexternal="${javadoc.check.external.links}"
report="${javadoc.out.dir}/checklinks-errors-${javadoc.name}.xml" checkspaces="false">
<include name="overview-summary.html"/>
<include name="apichanges.html"/>
<include name="architecture-summary.html"/>
<include name="**/package-summary.html"/> <!--<include name="**/doc-files/**/*.html"/>-->
<include name="**/*.html"/> <!-- XXX why are not all **/*.html checked? Would then need to allow e.g. http://blogs.sun.com/geertjan/entry/swing_outline_component from OutlineView.html --> <!-- Make hyperlinks point to the source files, not the copied files: --> <!-- XXX but line numbers are wrong in several cases! --> <!-- checking all html file for now on -->
<mapper type="glob" from="${javadoc.out.dir}/overview-summary.html" to="${javadoc.arch}"/>
<mapper type="glob" from="${javadoc.out.dir}/*/package-summary.html" to="${javadoc.docfiles}/*/package.html"/>
<mapper type="glob" from="${javadoc.out.dir}/*/package-summary.html" to="${javadoc.src}/*/package.html"/>
<mapper type="glob" from="${javadoc.out.dir}/apichanges.html" to="${javadoc.apichanges}"/>
<mapper type="glob" from="${javadoc.out.dir}/architecture-summary.html" to="${javadoc.arch}"/>
<mapper type="glob" from="${javadoc.out.dir}/*.html" to="${javadoc.docfiles}/*.html"/>
<mapper type="glob" from="${javadoc.out.dir}/*.html" to="${javadoc.src}/*.html"/>
&disallowed-links;
</checklinks> <!-- XXX run doctorj (doctorj.sf.net) if it is installed? -->
</target>
<target name="javadoc" depends="javadoc-stage-check" unless="javadoc.up.to.date" description="Build Javadoc and associated documentation for a module.">
<zip zipfile="${javadoc.out.zip}" basedir="${javadoc.out.dir}"/>
</target>
</project>
¤ Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.0.17Bemerkung:
Wie Sie bei der Firma Beratungs- und Dienstleistungen beauftragen können
¤
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung ist noch experimentell.