org.codehaus.mojo.servicedocgen.introspection

Class JavaDocHelper

java.lang.Object

org.codehaus.mojo.servicedocgen.introspection.JavaDocHelper

public class JavaDocHelper
extends Object

Helper to parse JavaDoc tags and transform to regular HTML.

Author:

hohwille

See Also:

parseJavaDoc(JavaClass, GenericType, String)

Field Summary

Fields

Modifier and Type	Field and Description
protected com.thoughtworks.qdox.JavaProjectBuilder	builder
static String	JAVADOC_JAVAEE_URL JavaDoc URL for Java Enterprise Edition.
static String	JAVADOC_JAVASE_URL JavaDoc URL for Java Standard Edition.

Constructor Summary

Constructors

Constructor and Description
JavaDocHelper(ClassLoader classloader, com.thoughtworks.qdox.JavaProjectBuilder builder, List<JavaDocDescriptor> javaDocs) The constructor.

Method Summary

Modifier and Type	Method and Description
String	getQualifiedName(com.thoughtworks.qdox.model.JavaSource source, String simpleName)
String	parseJavaDoc(com.thoughtworks.qdox.model.JavaClass sourceType, net.sf.mmm.util.reflect.api.GenericType<?> byteType, String javadoc) Parses JavaDoc and resolves tags such as @link, @linkplain, @literal, @value, or @code.

Methods inherited from class java.lang.Object

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

Field Detail

JAVADOC_JAVASE_URL

public static final String JAVADOC_JAVASE_URL

JavaDoc URL for Java Standard Edition.

See Also:

Constant Field Values

JAVADOC_JAVAEE_URL

public static final String JAVADOC_JAVAEE_URL

JavaDoc URL for Java Enterprise Edition.

See Also:

Constant Field Values

builder

protected final com.thoughtworks.qdox.JavaProjectBuilder builder

Constructor Detail

JavaDocHelper

public JavaDocHelper(ClassLoader classloader,
                     com.thoughtworks.qdox.JavaProjectBuilder builder,
                     List<JavaDocDescriptor> javaDocs)

The constructor.

Parameters:

classloader - the ClassLoader used to load byte-code classes dynamically.

builder - the JavaProjectBuilder for source-code analysis.

javaDocs - the configured List of JavaDocDescriptors.

Method Detail

getQualifiedName

public String getQualifiedName(com.thoughtworks.qdox.model.JavaSource source,
                               String simpleName)

Parameters:

source - the JavaSource.

simpleName - the simple name of a class.

Returns:

the qualified name of the class.

parseJavaDoc

public String parseJavaDoc(com.thoughtworks.qdox.model.JavaClass sourceType,
                           net.sf.mmm.util.reflect.api.GenericType<?> byteType,
                           String javadoc)

Parses JavaDoc and resolves tags such as @link, @linkplain, @literal, @value, or @code.

Parameters:

sourceType - the JavaClass from source-code analysis.

byteType - the GenericType from byte-code analysis.

javadoc - the JavaDoc comment to parse.

Returns:

the given JavaDoc comment transformed to a pure HTML fragment.