Template:Javadoc/doc

A template to link to the JDK documentation. A more up-to-date version of Javadoc:SE and Javadoc:EE.

Usage
An empty usage just links to the javadocs: →

Linking to a module: →

Linking to a package in that module: →

For, write  →

To link to a particular class member, write →

Overriding the text: →

A monospaced font can be used by writing →

Linking to a particular version can be done, too: →

Parameters

 * module
 * A module (e.g. 'java.base').


 * package
 * A package path (e.g. 'java.lang'). Different from module. Requires all the parameters above.


 * class
 * The class to link to. Requires all the parameters above.


 * member
 * A member (method or field) that is part of the class. Requires all the parameters above.


 * version
 * The Java version number to link to (11 and up).


 * text
 * The text to override the default link text.


 * monotype
 * Whether to surround the link with tags.

Templatedata
{	"params": { "monotype": { "label": "Monospaced font", "description": "Makes the font monospaced rather than normal text", "type": "boolean", "autovalue": "y" },		"version": { "label": "JDK version", "description": "The version of the JDK to link to (11 and up)", "example": "15", "type": "number" },		"module": { "label": "Module", "description": "The module to link to", "example": "java.base", "type": "string", "suggestedvalues": [ "java.base", "java.compiler", "java.datatransfer", "java.desktop", "java.instrument", "java.logging", "java.management", "java.management.rmi", "java.naming", "java.net.http", "java.prefs", "java.rmi", "java.scripting", "java.se", "java.security.jgss", "java.security.sasl", "java.smartcardio", "java.sql", "java.sql.rowset", "java.transaction.xa", "java.xml", "java.xml.crypto" ],			"suggested": true },		"package": { "label": "Package", "description": "The package to link to (requires module)", "example": "java.lang", "type": "string", "suggested": true },		"class": { "label": "Class", "description": "The class to link to (requires module and package)", "example": "Object", "type": "string", "suggested": true },		"member": { "label": "Member", "description": "Link to a member in the class (requires class, package, and module)", "example": "clone", "type": "string" },		"text": { "label": "Override text", "description": "Overrides the link's text", "type": "string", "suggested": true }	},	"paramOrder": [ "version", "module", "package", "class", "member", "text", "monotype" ],	"format": "inline" }