Zeus web server - Try It Out: Javadoc Options In the next
Try It Out: Javadoc Options In the next step you can determine the content and the layout of the single Javadoc pages. The following options exist: . Generate Use Page. This option allows you to generate a cross-reference for each class and each package. . Generate Hierarchy Tree. When you check this option, a page is generated that displays the hierarchy of packages, classes, and interfaces. . Generate Navigator Bar. This option generates a navigation bar at the top and at the bottom of each page. . Generate Index. This option generates one or several index pages. . Separate Index per Letter. Check this option to generate a separate index page for each letter in the alphabet. . @author, @version, @deprecated. When these options are set, the corresponding key words in the Javadoc comments are evaluated and their information is included in the generated pages. . Deprecated List. This option allows a separate page to be generated, listing all elements marked as deprecated. In addition, you can create links to other Javadoc documentations. Try It Out: Command-Line Options On the next wizard page (Figure 6.9), you can specify additional command-line options for javadoc .exe, if necessary. In addition, you can specify a file containing additional text for the Javadoc Overview page. The JRE 1.4 Source Compatibility option must be checked if your source code contains the Java assert keyword. Without this option set, Java 1.4 programs that contain this instruction would cause errors during the Javadoc generation. Checking this option is equivalent to specifying the command-line option -source 1.4. You can also optionally create an Ant script for Javadoc generation (Figure 6.10). I will discuss Ant in more detail in Chapter 13. After you press Finish, the Javadoc generation is started as a batch job. The output of the batch job appears on the Eclipse Java console. 126 Chapter 6
Our window web hosting plans are bursting with features and FREE tools, at the very small rate. Sign up today window web hosting.