com.revolsys.doclet

Class DocletUtil

java.lang.Object

com.revolsys.doclet.DocletUtil

public class DocletUtil
extends Object

Constructor Summary

Constructors

Constructor and Description
DocletUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addPackageUrl(String packagePrefix, String url)
static void	anchor(XmlWriter writer, String name, String title)
static void	copyFiles(String destDir)
static void	description(XmlWriter writer, com.sun.javadoc.ClassDoc containingClass, com.sun.javadoc.Doc doc)
static void	description(XmlWriter writer, com.sun.javadoc.ClassDoc containingClass, com.sun.javadoc.Tag[] tags)
static void	descriptionTd(XmlWriter writer, com.sun.javadoc.ClassDoc containingClass, Map<String,com.sun.javadoc.Tag[]> descriptions, String name)
static void	documentationReturn(XmlWriter writer, com.sun.javadoc.MethodDoc method)
static com.sun.javadoc.AnnotationDesc	getAnnotation(com.sun.javadoc.AnnotationDesc[] annotations, String name)
static com.sun.javadoc.AnnotationDesc	getAnnotation(com.sun.javadoc.ProgramElementDoc doc, String name)
static String	getExternalUrl(String qualifiedTypeName)
static Map<String,com.sun.javadoc.Tag[]>	getParameterDescriptions(com.sun.javadoc.ExecutableMemberDoc method)
static boolean	hasAnnotation(com.sun.javadoc.AnnotationDesc[] annotations, String name)
static boolean	hasAnnotation(com.sun.javadoc.ProgramElementDoc doc, String name)
static void	head(XmlWriter writer, String docTitle)
static boolean	isTypeIncluded(com.sun.javadoc.Type type)
static void	label(XmlWriter writer, String label, boolean code)
static void	link(XmlWriter writer, String url, String label, boolean code)
static String	qualifiedName(com.sun.javadoc.ProgramElementDoc element)
static String	replaceDocRootDir(String text)
static void	seeTag(XmlWriter writer, com.sun.javadoc.ClassDoc containingClass, com.sun.javadoc.SeeTag seeTag)
static void	tagWithAnchor(XmlWriter writer, QName tag, String name, String title)
static void	title(XmlWriter writer, String title)
static void	title(XmlWriter writer, String name, String title)
static void	typeName(XmlWriter writer, com.sun.javadoc.Type type)
static void	typeNameLink(XmlWriter writer, com.sun.javadoc.Type type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocletUtil

public DocletUtil()

Method Detail

addPackageUrl

public static void addPackageUrl(String packagePrefix,
                 String url)

anchor

public static void anchor(XmlWriter writer,
          String name,
          String title)

copyFiles

public static void copyFiles(String destDir)

description

public static void description(XmlWriter writer,
               com.sun.javadoc.ClassDoc containingClass,
               com.sun.javadoc.Doc doc)

description

public static void description(XmlWriter writer,
               com.sun.javadoc.ClassDoc containingClass,
               com.sun.javadoc.Tag[] tags)

descriptionTd

public static void descriptionTd(XmlWriter writer,
                 com.sun.javadoc.ClassDoc containingClass,
                 Map<String,com.sun.javadoc.Tag[]> descriptions,
                 String name)

documentationReturn

public static void documentationReturn(XmlWriter writer,
                       com.sun.javadoc.MethodDoc method)

getAnnotation

public static com.sun.javadoc.AnnotationDesc getAnnotation(com.sun.javadoc.AnnotationDesc[] annotations,
                                           String name)

getAnnotation

public static com.sun.javadoc.AnnotationDesc getAnnotation(com.sun.javadoc.ProgramElementDoc doc,
                                           String name)

getExternalUrl

public static String getExternalUrl(String qualifiedTypeName)

getParameterDescriptions

public static Map<String,com.sun.javadoc.Tag[]> getParameterDescriptions(com.sun.javadoc.ExecutableMemberDoc method)

hasAnnotation

public static boolean hasAnnotation(com.sun.javadoc.AnnotationDesc[] annotations,
                    String name)

hasAnnotation

public static boolean hasAnnotation(com.sun.javadoc.ProgramElementDoc doc,
                    String name)

head

public static void head(XmlWriter writer,
        String docTitle)

isTypeIncluded

public static boolean isTypeIncluded(com.sun.javadoc.Type type)

label

public static void label(XmlWriter writer,
         String label,
         boolean code)

link

public static void link(XmlWriter writer,
        String url,
        String label,
        boolean code)

qualifiedName

public static String qualifiedName(com.sun.javadoc.ProgramElementDoc element)

replaceDocRootDir

public static String replaceDocRootDir(String text)

seeTag

public static void seeTag(XmlWriter writer,
          com.sun.javadoc.ClassDoc containingClass,
          com.sun.javadoc.SeeTag seeTag)

tagWithAnchor

public static void tagWithAnchor(XmlWriter writer,
                 QName tag,
                 String name,
                 String title)

title

public static void title(XmlWriter writer,
         String title)

title

public static void title(XmlWriter writer,
         String name,
         String title)

typeName

public static void typeName(XmlWriter writer,
            com.sun.javadoc.Type type)

typeNameLink

public static void typeNameLink(XmlWriter writer,
                com.sun.javadoc.Type type)