8010495: Update JAXP NetBeans project - add support for generating javadoc

Make it possible to use NetBeans to edit the jaxp sources and to generate a preview of the associated javadoc.

Reviewed-by: joehw, alanb
This commit is contained in:
Daniel Fuchs 2013-04-19 17:22:36 +02:00
parent 9a94591b8e
commit 911f441787
2 changed files with 57 additions and 1 deletions

View File

@ -176,4 +176,42 @@
<echo message="+---------------------------------------+"/> <echo message="+---------------------------------------+"/>
</target> </target>
<target name="javadoc" depends="init" description="Build basic Javadoc for public packages.">
<property name="javadoc.options" value=""/> <!-- default, can be overridden per user or per project -->
<!-- Note: even with this default value, includes/excludes
from share.src.dir get javadoc'd; see packageset below -->
<property name="javadoc.packagenames" value="none"/> <!-- default, can be overridden per user or per project -->
<property name="javadoc.dir" value="${build.dir}/docs/api"/>
<property name="includes" value="**"/>
<javadoc destdir="${javadoc.dir}" source="1.5"
windowtitle="UNOFFICIAL" failonerror="true" use="true"
author="false" version="false"
packagenames="${javadoc.packagenames}">
<header><![CDATA[<strong>Unofficial Javadoc</strong> generated from developer sources for preview purposes only]]></header>
<arg line="${javadoc.options}"/>
<bootclasspath>
<path location="${java.home}/lib/rt.jar"/>
<path location="${build.classes.dir}"/>
</bootclasspath>
<sourcepath>
<pathelement location="${jaxp.src.dir}"/>
</sourcepath>
<!-- XXX just <fileset> (restricted further to **/*.java) and no <packageset> -->
<!-- means that {@link some.package} will not work, which is no good. -->
<!-- (It correctly skips excluded single classes, but not if packageset is also included, -->
<!-- which also causes duplicates in the class index for included files.) -->
<packageset dir="${jaxp.src.dir}" includes="${includes}" excludes="${excludes}">
<or>
<filename name="javax/"/>
<filename name="org/w3c/"/>
<filename name="org/xml/sax/"/>
</or>
</packageset>
</javadoc>
</target>
<target name="javadoc-nb" depends="javadoc" if="netbeans.home">
<property name="javadoc.dir=" value="${build.dir}/docs/api"/>
<nbbrowse file="${javadoc.dir}/index.html"/>
</target>
</project> </project>

View File

@ -15,6 +15,12 @@
<location>.</location> <location>.</location>
<encoding>UTF-8</encoding> <encoding>UTF-8</encoding>
</source-folder> </source-folder>
<source-folder>
<label>src</label>
<type>java</type>
<location>src</location>
<encoding>UTF-8</encoding>
</source-folder>
</folders> </folders>
<ide-actions> <ide-actions>
<action name="build"> <action name="build">
@ -27,9 +33,16 @@
<target>clean</target> <target>clean</target>
<target>build</target> <target>build</target>
</action> </action>
<action name="javadoc">
<target>javadoc-nb</target>
</action>
</ide-actions> </ide-actions>
<view> <view>
<items> <items>
<source-folder style="packages">
<label>src</label>
<location>src</location>
</source-folder>
<source-file> <source-file>
<location>build.xml</location> <location>build.xml</location>
</source-file> </source-file>
@ -38,11 +51,16 @@
<ide-action name="build"/> <ide-action name="build"/>
<ide-action name="rebuild"/> <ide-action name="rebuild"/>
<ide-action name="clean"/> <ide-action name="clean"/>
<ide-action name="javadoc"/>
</context-menu> </context-menu>
</view> </view>
<subprojects/> <subprojects/>
</general-data> </general-data>
<java-data xmlns="http://www.netbeans.org/ns/freeform-project-java/1"/> <java-data xmlns="http://www.netbeans.org/ns/freeform-project-java/1">
<compilation-unit>
<package-root>src</package-root>
</compilation-unit>
</java-data>
<preferences xmlns="http://www.netbeans.org/ns/auxiliary-configuration-preferences/1"> <preferences xmlns="http://www.netbeans.org/ns/auxiliary-configuration-preferences/1">
<module name="org-netbeans-modules-editor-indent"/> <module name="org-netbeans-modules-editor-indent"/>
</preferences> </preferences>