Class DocGenerator.Tool

java.lang.Object
org.java.plugin.tools.docgen.DocGenerator.Tool
Enclosing class:
DocGenerator

public static final class DocGenerator.Tool extends Object
Utility class to be used from JXP templates.
Version:
$Id$
  • Constructor Details

    • Tool

      protected Tool(String aRelativePath)
  • Method Details

    • getLink

      public String getLink(Documentation.Reference<?> ref)
      Parameters:
      ref - documentation reference element
      Returns:
      link to be used in "href" attribute
    • isAbsoluteUrl

      public boolean isAbsoluteUrl(String url)
      Parameters:
      url - an URL to check
      Returns:
      true if given link is an absolute URL
    • processDocText

      public String processDocText(String text)
      Substitutes all ${relativePath} variables with their values.
      Parameters:
      text - text to be processed
      Returns:
      processed documentation text