Next: 4.11 Generating RPMs for Up: 4. Wrapping Objective-C Libraries Previous: 4.9 Including Special Code

Subsections

• 4.10.1 Generating Documentation for Packages
• 4.10.2 Installation Directory

4.10 Controlling the Quick Reference Documentation

This section documents special options which control the quick reference documentation which JIGS automatically generates with the wrappers. You may safely skip this section at a first reading. You need to read the section 4.9 before reading this one.

4.10.1 Generating Documentation for Packages

By default, JIGS will treat the Java classes as separate classes, and document them accordingly. If you are rather creating a complete package you may want javadoc documentation for the package. This is not very different, it just additionally includes a useful index with the list of all the classes in the package.

To get this behaviour, you need to write a

GNUmakefile.wrapper.java.preamble

and set Reference_JAVADOC_FILES in it. For example, when wrapping the GNUstep Base Library we do:

Reference_JAVADOC_FILES = gnu.gnustep.base

4.10.2 Installation Directory

By default, JIGS will install the quick reference documentation into

$(GNUSTEP_INSTALLATION_DIR)/Developer/libMyLibrary/Java/Reference/

where of course libMyLibrary is replaced with your library name. If you want to change it, you need to write a

GNUmakefile.wrapper.java.preamble

and set Reference_DOC_INSTALL_DIR in it. For example, when compiling the GNUstep Base Library wrappers we use

Reference_DOC_INSTALL_DIR = Developer/Base/Java/

which installs the documentation into

$(GNUSTEP_INSTALLATION_DIR)/Developer/Base/Java/Reference/

Next: 4.11 Generating RPMs for Up: 4. Wrapping Objective-C Libraries Previous: 4.9 Including Special Code