Java

Summary: Easily generates links to the Javadoc API.

Version: 20110525

Prerequisites:

Status: beta

Maintainer: Daniel Kasmeroglu

Categories: Links

Users: (view ? / edit)

Discussion: Java-Talk ?

Description

This recipe just provides a convenient way to link to Javadoc APIs.

Installation

Copy java.php Δ to your /cookbook/ directory.
Add the following line to your /cookbook/local/config.php file:

include_once("$FarmD/cookbook/java.php");

Configuration

You can set the following two variables within your /cookbook/local/config.php file:

 $java_api:   Specifies the location of the API documentation. Default: http://download.oracle.com/javase/1.4.2/docs/api/.
 $java_mode:  If set to "simplename" only the classes simplename is displayed. Otherwise the fully qualified classname is displayed. Default: "".

Usage

The syntax is quite simple: java:java.lang.Float will generate a link to the corresponding Javadoc page. All classes within the package java.lang are allowed to be shortened such as java:Float which would generate the same link.

Change log / Release notes

20110525 - initial release.

Contributors

Daniel Kasmeroglu is the original author of this recipe.

Comments

See discussion at Java-Talk ?

User notes ? : If you use, used or reviewed this recipe, you can add your name. These statistics appear in the Cookbook listings and will help newcomers browsing through the wiki.