Package org.java.plugin.tools.docgen
Class DocGenerator.Tool
java.lang.Object
org.java.plugin.tools.docgen.DocGenerator.Tool
- Enclosing class:
- DocGenerator
Utility class to be used from JXP templates.
- Version:
- $Id$
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetLink
(Documentation.Reference<?> ref) boolean
isAbsoluteUrl
(String url) processDocText
(String text) Substitutes all ${relativePath} variables with their values.
-
Constructor Details
-
Tool
-
-
Method Details
-
getLink
- Parameters:
ref
- documentation reference element- Returns:
- link to be used in "href" attribute
-
isAbsoluteUrl
- Parameters:
url
- an URL to check- Returns:
true
if given link is an absolute URL
-
processDocText
Substitutes all ${relativePath} variables with their values.- Parameters:
text
- text to be processed- Returns:
- processed documentation text
-