Package com.intellij.codeInspection.javaDoc

Class JavaDocReferenceInspection

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.LocalInspectionTool

com.intellij.codeInspection.javaDoc.JavaDocReferenceInspection

All Implemented Interfaces:

BatchSuppressableTool

public class JavaDocReferenceInspection
extends LocalInspectionTool

Field Summary

Fields

Modifier and Type	Field and Description
boolean	REPORT_INACCESSIBLE

Fields inherited from class com.intellij.codeInspection.LocalInspectionTool

EMPTY_ARRAY, VALID_ID_PATTERN

Fields inherited from class com.intellij.codeInspection.InspectionProfileEntry

myNameProvider

Constructor Summary

Constructors

Constructor and Description
JavaDocReferenceInspection()

Method Summary

Modifier and Type	Method and Description
PsiElementVisitor	buildVisitor(ProblemsHolder holder, boolean isOnTheFly) Override the method to provide your own inspection visitor.
javax.swing.JComponent	createOptionsPanel() This method is called each time UI is shown.
HighlightDisplayLevel	getDefaultLevel() DO NOT OVERRIDE this method.
java.lang.String	getGroupDisplayName()
java.lang.String	getShortName() DO NOT OVERRIDE this method.
boolean	isEnabledByDefault() DO NOT OVERRIDE this method.

Methods inherited from class com.intellij.codeInspection.LocalInspectionTool

buildVisitor, checkFile, getAlternativeID, getID, getProblemElement, getSuppressId, inspectionFinished, inspectionFinished, inspectionStarted, isValidID, processFile, runForWholeFile

Methods inherited from class com.intellij.codeInspection.InspectionProfileEntry

cleanup, getBatchSuppressActions, getBlackList, getDescriptionContextClass, getDescriptionFileName, getDisplayName, getGeneralGroupName, getGroupKey, getGroupPath, getMainToolId, getSerializationFilter, getShortName, getStaticDescription, getSuppressors, initialize, isInitialized, isSuppressedFor, loadDescription, readSettings, showDefaultConfigurationOptions, writeSettings

Methods inherited from class java.lang.Object

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

Field Detail

REPORT_INACCESSIBLE

public boolean REPORT_INACCESSIBLE

Constructor Detail

JavaDocReferenceInspection

public JavaDocReferenceInspection()

Method Detail

createOptionsPanel

public javax.swing.JComponent createOptionsPanel()

Description copied from class: InspectionProfileEntry

This method is called each time UI is shown.

Overrides:

createOptionsPanel in class InspectionProfileEntry

Returns:

null if no UI options required.

isEnabledByDefault

public boolean isEnabledByDefault()

Description copied from class: InspectionProfileEntry

DO NOT OVERRIDE this method.

Overrides:

isEnabledByDefault in class InspectionProfileEntry

See Also:

InspectionEP.enabledByDefault

getGroupDisplayName

public java.lang.String getGroupDisplayName()

Overrides:

getGroupDisplayName in class InspectionProfileEntry

See Also:

InspectionEP.groupDisplayName, InspectionEP.groupKey, InspectionEP.groupBundle

getShortName

public java.lang.String getShortName()

Description copied from class: InspectionProfileEntry

DO NOT OVERRIDE this method.

Overrides:

getShortName in class InspectionProfileEntry

See Also:

InspectionEP.shortName

getDefaultLevel

public HighlightDisplayLevel getDefaultLevel()

Description copied from class: InspectionProfileEntry

DO NOT OVERRIDE this method.

Overrides:

getDefaultLevel in class InspectionProfileEntry

See Also:

InspectionEP.level

buildVisitor

public PsiElementVisitor buildVisitor(ProblemsHolder holder,
                                      boolean isOnTheFly)

Description copied from class: LocalInspectionTool

Override the method to provide your own inspection visitor. Created visitor must not be recursive (e.g. it must not inherit PsiRecursiveElementVisitor) since it will be fed with every element in the file anyway. Visitor created must be thread-safe since it might be called on several elements concurrently.

Overrides:

buildVisitor in class LocalInspectionTool

Parameters:

holder - where visitor will register problems found.

isOnTheFly - true if inspection was run in non-batch mode

Returns:

not-null visitor for this inspection.

See Also:

PsiRecursiveVisitor