DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:javadoc

Javadoc Plugin

Compatible with DokuWiki

  • 2017-02-19 "Frusterick Manners" unknown
  • 2016-06-26 "Elenor Of Tsort" unknown
  • 2015-08-10 "Detritus" yes
  • 2014-09-29 "Hrun" yes

plugin Link to a Javadoc API using class/method name and a site reference (previous authors: Damien Coraboeuf)

Last updated on
2014-08-10
Provides
Syntax
Repository
Source

Tagged with html, java, links

Description

This plugin offers a convenient way to reference Javadoc API pages. It is particularly useful when creating Java technical documentation to reference the classes being used.

Given a class name (and a method name) and a site reference, a link is automatically generated to the corresponding Javadoc API page.

Download and Installation

Download and install the plugin using the Plugin Manager using the download link given above. Refer to Plugins on how to install plugins manually.

dokuwiki-plugin-javadoc-2014-08-09

Changes in 2014-08-10

  • Updated date (version) in plugin.info.txt

Changes in 2014-08-09

  • Added option to hide Java icon before Javadoc links.
  • Updated default Javadoc URL to Java 8

Changes in 2013-05-20

  • Updated plugin information
  • Updated javadoc icon
  • Added configuration
  • Updated JDK Javadoc base URL

Usage

Surround a Java class name with <javadoc> and </javadoc> tags to create a Javadoc URL. The plugin generates a link referring to the Javadoc URL of the class. The link text is the class name and is displayed as code.

<javadoc>java.lang.String</javadoc>

It's also possible to refer to a class element such as a method. Use the Javadoc @link syntax to do so.

Attention: This currently does not work for methods with more than one parameter.

<javadoc>java.lang.String#concat(java.lang.String)</javadoc>

Use a vertical bar to specify a custom link text:

<javadoc>java.lang.String#concat(java.lang.String)|concat()</javadoc>

Include a site identifier in the opening tag to refer to a custom Javadoc base URL. Up to five site identifiers can be configured:

<javadoc jeda>ch.jeda.Program</javadoc>

Configuration

The default Javadoc base URL can be configured. The configuration value must be a valid JDK Javadoc base URL.

Also, up to five custom Javadoc base URLs can be configured. The configuration value must be a valid Javadoc base URL. Optionally, a custom site identifier may be prepended to the URL. Site identifier and URL must be separated by a space:

Parameter Example Description
jdk http://docs.oracle.com/javase/7/docs/api Base URL for standard JDK Javadoc
user1 jeda http://jeda.ch/api First custom Javadoc base URL
user2 doolin http://www.doolin-guif.net/reports/apidocs Second custom Javadoc base URL
user3 commons-beanutil commons.apache.org/proper/commons-beanutils/api Third custom Javadoc base URL
user4 Fourth custom Javadoc base URL
user5 Fifth custom Javadoc base URL

Comments

plugin/javadoc.txt · Last modified: 2015-12-16 15:52 by 86.118.137.200