Package com.intellij.codeInsight.javadoc

Class JavaDocInfoGenerator

java.lang.Object

com.intellij.codeInsight.javadoc.JavaDocInfoGenerator

Direct Known Subclasses:

GroovyDocInfoGenerator

public class JavaDocInfoGenerator
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
JavaDocInfoGenerator(Project project, PsiElement element)

Method Summary

Modifier and Type	Method and Description
static void	appendExpressionValue(java.lang.StringBuilder buffer, PsiExpression initializer)
static PsiExpression	calcInitializerExpression(PsiVariable variable)
protected void	collectElementText(java.lang.StringBuilder buffer, PsiElement element)
protected java.lang.String	createLinkText(PsiElement[] tagElements)
static void	enumConstantOrdinal(java.lang.StringBuilder buffer, PsiField field, PsiClass parentClass, java.lang.String newLine)
void	generateCommonSection(java.lang.StringBuilder buffer, PsiDocComment docComment)
java.lang.String	generateDocInfo(java.util.List<java.lang.String> docURLs)
boolean	generateDocInfoCore(java.lang.StringBuilder buffer, boolean generatePrologue)
java.lang.String	generateMethodParameterJavaDoc()
java.lang.String	generateRenderedDocInfo()
protected void	generateSeeAlsoSection(java.lang.StringBuilder buffer, PsiDocComment comment)
static java.lang.String	generateSignature(PsiElement element)
static int	generateType(java.lang.StringBuilder buffer, PsiType type, PsiElement context)
static int	generateType(java.lang.StringBuilder buffer, PsiType type, PsiElement context, boolean generateLink)
static int	generateType(java.lang.StringBuilder buffer, PsiType type, PsiElement context, boolean generateLink, boolean useShortNames)
static boolean	isDocumentedAnnotationType(PsiClass resolved)
static boolean	isRepeatableAnnotationType(PsiElement annotationType)

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaDocInfoGenerator

public JavaDocInfoGenerator(Project project,
                            PsiElement element)

Method Detail

generateDocInfoCore

public boolean generateDocInfoCore(java.lang.StringBuilder buffer,
                                   boolean generatePrologue)

generateSignature

public static java.lang.String generateSignature(PsiElement element)

generateDocInfo

public java.lang.String generateDocInfo(java.util.List<java.lang.String> docURLs)

generateRenderedDocInfo

public java.lang.String generateRenderedDocInfo()

enumConstantOrdinal

public static void enumConstantOrdinal(java.lang.StringBuilder buffer,
                                       PsiField field,
                                       PsiClass parentClass,
                                       java.lang.String newLine)

generateCommonSection

public void generateCommonSection(java.lang.StringBuilder buffer,
                                  PsiDocComment docComment)

calcInitializerExpression

public static PsiExpression calcInitializerExpression(PsiVariable variable)

appendExpressionValue

public static void appendExpressionValue(java.lang.StringBuilder buffer,
                                         PsiExpression initializer)

isDocumentedAnnotationType

public static boolean isDocumentedAnnotationType(PsiClass resolved)

isRepeatableAnnotationType

public static boolean isRepeatableAnnotationType(PsiElement annotationType)

generateMethodParameterJavaDoc

public java.lang.String generateMethodParameterJavaDoc()

createLinkText

protected java.lang.String createLinkText(PsiElement[] tagElements)

collectElementText

protected void collectElementText(java.lang.StringBuilder buffer,
                                  PsiElement element)

generateSeeAlsoSection

protected void generateSeeAlsoSection(java.lang.StringBuilder buffer,
                                      PsiDocComment comment)

generateType

public static int generateType(java.lang.StringBuilder buffer,
                               PsiType type,
                               PsiElement context)

Returns:

Length of the generated label.

generateType

public static int generateType(java.lang.StringBuilder buffer,
                               PsiType type,
                               PsiElement context,
                               boolean generateLink)

Returns:

Length of the generated label.

generateType

public static int generateType(java.lang.StringBuilder buffer,
                               PsiType type,
                               PsiElement context,
                               boolean generateLink,
                               boolean useShortNames)

Returns:

Length of the generated label.