Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Doctypemacrohide
NameJavadoc Link Macro 
Short DescriptionLinks API documentation pages for Java elements. 
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 
Categories
Name List
doctypecategory
namesLink / Information System
 
Tags
Tag List
namesLink Resource, Remote Reference
 
Iteration
Iteration
valueproduction
hide
ExtensionInformation Systems Extension 
Since1.0 
Sort Keyhide
Section
indextrue
show-titlefalse
titleDescription

Renders a link to a Java element in a Javadoc API.

The macros purpose is to specify the reference to the system serving the Javadoc API for the project at one place (as a Confluence shortcut or space property) and reuse this URL throughout the usage of this macro. The body of the macro contains a reference to the Java element to point to.

Section
Column
Panel
titleMacro Editor

Macro Editor

Column
Content Marker
idexample
Example Box
titleJava Elements in Javadoc

To reference the a class, specify the name of the class like this:

Code Block
com.example.something.MyClass

The following example references a method aMethod():

Code Block
com.example.something.MyClass.aMethod()

Here an example referencing a method aMethod(String, Class<?>) with generics:

Code Block
com.example.something.MyClass.aMethod(java.lang.String, java.lang.Class)

Note to specify the parameters fully qualified and that generic type parameters or wildcards are not part of the reference.

This macro does not import Javadoc HTML pages into Confluence to make them searchable. It is used to create a link to an element of the API in a Confluence page. The base URL to the API home is defined by a space property and the relative URL is generated by the information passed to the macro (e.g. the name of the class).

Transclusion
documentInformation System Extension Notice
idsSummary

...

Section
titleReferences

Section
titleResources

Piwik Set Multiple Custom Variables
NameValue
Departmentprojectdoc
Categoryprojectdoc-macro
Typeremote