org.jsweet.transpiler.util

Class JSDoc

java.lang.Object

org.jsweet.transpiler.util.JSDoc

public class JSDoc
extends Object

A utility class to print JSDoc comments from regular Java comments.

Author:

Renaud Pawlak

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	authorPattern A regexp that matches JavaDoc @author expressions.
static Pattern	linkPattern A regexp that matches JavaDoc @link expressions.
static Pattern	paramPattern A regexp that matches JavaDoc @param expressions.
static Pattern	returnPattern A regexp that matches JavaDoc @return expression.

Method Summary

Modifier and Type	Method and Description
static String	adaptDocComment(JSweetContext context, com.sun.tools.javac.tree.JCTree.JCCompilationUnit compilationUnit, com.sun.tools.javac.tree.JCTree element, String commentText) Adapts the JavaDoc comment for a given element to conform to JSDoc.
static String	getMappedDocType(JSweetContext context, com.sun.tools.javac.tree.JCTree typeTree, com.sun.tools.javac.code.Type type) Gets the JSDoc type from a Java type tree and/or type.
static String	replaceLinks(JSweetContext context, String text) Replaces Java links by JSDoc links in a doc text.

Methods inherited from class java.lang.Object

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

Field Detail

paramPattern

public static final Pattern paramPattern

A regexp that matches JavaDoc @param expressions.

authorPattern

public static final Pattern authorPattern

A regexp that matches JavaDoc @author expressions.

returnPattern

public static final Pattern returnPattern

A regexp that matches JavaDoc @return expression.

linkPattern

public static final Pattern linkPattern

A regexp that matches JavaDoc @link expressions.

Method Detail

getMappedDocType

public static String getMappedDocType(JSweetContext context,
                                      com.sun.tools.javac.tree.JCTree typeTree,
                                      com.sun.tools.javac.code.Type type)

Gets the JSDoc type from a Java type tree and/or type.

Parameters:

typeTree - the Java type tree

type - the Java type

Returns:

the JSDoc type

replaceLinks

public static String replaceLinks(JSweetContext context,
                                  String text)

Replaces Java links by JSDoc links in a doc text.

adaptDocComment

public static String adaptDocComment(JSweetContext context,
                                     com.sun.tools.javac.tree.JCTree.JCCompilationUnit compilationUnit,
                                     com.sun.tools.javac.tree.JCTree element,
                                     String commentText)

Adapts the JavaDoc comment for a given element to conform to JSDoc.

By default, this implementation does not auto-generate comments. This behavior can be overridden by adding a line in the comment before calling this method. For example:

 public String adaptDocComment(JCTree element, String commentText) {
        if (commentText == null) {
                return "My default comment";
        }
        super(element, commentText);
 }
 

Parameters:

element - the documented element

commentText - the comment text if any (null when no comment)

Returns:

the adapted comment (null will remove the JavaDoc comment)