[icedtea-web] RFC: Add documentation support

Dr Andrew John Hughes ahughes at redhat.com
Fri Nov 26 07:10:12 PST 2010


This adds API docs for the NetX and plugin packages, as promised
yesterday.  We did do this before (it lurked deep in a patch to
the OpenJDK build) but I've expanded it to also cover the NetX
classes (which are quite well-documented) and the plugin.

I haven't covered this in the patch, but we should also be installing
the architecture documentation provided by Deepak.

2010-11-25  Andrew John Hughes  <ahughes at redhat.com>

	* Makefile.am:
	(JDK_UPDATE_VERSION): Document.
	(NETX_PKGS): NetX packages for documentation.
	(PLUGIN_PKGS): Same for the plugin.
	(JAVADOC_OPTS): Common options passed to javadoc.
	(JAVADOC_MEM_OPTS): Memory options passed to JVM
	if possible (taken from the previous OpenJDK build).
	(all-local): Depend on docs.stamp.
	(clean-local): Add clean-docs.
	(.PHONY): Add clean-docs, clean-plugin-docs, clean-netx-docs.
	(install-exec-local): Install the documentation if enabled.
	(docs): Meta-dependency for netx-docs and plugin-docs.
	(clean-docs): Likewise but for clean targets.
	(netx-docs): Build documentation for the NetX API.
	(clean-netx-docs): Remove the NetX docs.
	(plugin-docs): Build documentation for the plugin API.
	(clean-plugin-docs): Likewise.
	(bootstrap-directory): Link to javadoc binary.
	* acinclude.m4:
	(IT_FIND_JAVADOC): Find a javadoc binary, first checking
	user input, then the JDK and the path for 'javadoc' and
	'gjdoc'.  Also sets JAVADOC_SUPPORTS_J_OPTIONS if it does.
	* configure.ac:
	Call IT_FIND_JAVADOC.

Ok?
-- 
Andrew :)

Free Java Software Engineer
Red Hat, Inc. (http://www.redhat.com)

Support Free Java!
Contribute to GNU Classpath and the OpenJDK
http://www.gnu.org/software/classpath
http://openjdk.java.net
PGP Key: 94EFD9D8 (http://subkeys.pgp.net)
Fingerprint = F8EF F1EA 401E 2E60 15FA  7927 142C 2591 94EF D9D8



More information about the distro-pkg-dev mailing list