org.tinyjee.maven.dim.extensions
Class JavaDocTagsHandler

java.lang.Object
  extended by org.tinyjee.maven.dim.extensions.JavaDocTagsHandler
All Implemented Interfaces:
Serializable

public class JavaDocTagsHandler
extends Object
implements Serializable

Implements a handler that can process javadoc comments and replace tags with XHTML markup.

See Also:
Serialized Form

Constructor Summary
JavaDocTagsHandler()
           
JavaDocTagsHandler(JavaClass javaClass, String javaDocRootPath, Map<String,Object> packageMappings)
           
 
Method Summary
 String processJavaDocComment(String comment)
          Processes all inline tags inside the javadoc comment.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JavaDocTagsHandler

public JavaDocTagsHandler()

JavaDocTagsHandler

public JavaDocTagsHandler(JavaClass javaClass,
                          String javaDocRootPath,
                          Map<String,Object> packageMappings)
Method Detail

processJavaDocComment

public String processJavaDocComment(String comment)
Processes all inline tags inside the javadoc comment.

Parameters:
comment - the comment to process.
Returns:
a comment with all common inline tags being processed.

toString

public String toString()
Overrides:
toString in class Object