Package com.intellij.codeInspection.javaDoc

Class JavaDocLocalInspection

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.LocalInspectionTool

com.intellij.codeInspection.javaDoc.JavaDocLocalInspection

All Implemented Interfaces:

BatchSuppressableTool

public class JavaDocLocalInspection
extends LocalInspectionTool

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaDocLocalInspection.Options

Field Summary

Fields

Modifier and Type	Field and Description
JavaDocLocalInspection.Options	FIELD_OPTIONS
boolean	IGNORE_DEPRECATED
boolean	IGNORE_DUPLICATED_THROWS Deprecated.
boolean	IGNORE_JAVADOC_PERIOD
boolean	IGNORE_POINT_TO_ITSELF
JavaDocLocalInspection.Options	INNER_CLASS_OPTIONS
JavaDocLocalInspection.Options	METHOD_OPTIONS
protected JavaDocLocalInspection.Options	MODULE_OPTIONS
java.lang.String	myAdditionalJavadocTags
protected static java.lang.String	NONE
protected static java.lang.String	PACKAGE_LOCAL
protected JavaDocLocalInspection.Options	PACKAGE_OPTIONS
protected static java.lang.String	PRIVATE
protected static java.lang.String	PROTECTED
protected static java.lang.String	PUBLIC
static java.lang.String	SHORT_NAME
JavaDocLocalInspection.Options	TOP_LEVEL_CLASS_OPTIONS

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
JavaDocLocalInspection()

Method Summary

Modifier and Type	Method and Description
PsiElementVisitor	buildVisitor(ProblemsHolder holder, boolean isOnTheFly) Override the method to provide your own inspection visitor.
protected LocalQuickFix	createAddJavadocFix(PsiElement nameIdentifier, boolean isOnTheFly)
protected LocalQuickFix	createAddMissingParamTagFix(java.lang.String name, boolean isOnTheFly)
protected LocalQuickFix	createAddMissingTagFix(java.lang.String tag, java.lang.String value, boolean isOnTheFly)
javax.swing.JComponent	createOptionsPanel() This method is called each time UI is shown.
protected LocalQuickFix	createRegisterTagFix(java.lang.String tag, boolean isOnTheFly)
java.lang.String	getAlternativeID() For global tools read-only, for local tools would be used instead getID for modules with alternative classpath storage
java.lang.String	getGroupDisplayName()
java.lang.String	getShortName() DO NOT OVERRIDE this method.
boolean	isEnabledByDefault() DO NOT OVERRIDE this method.
boolean	isIgnoreDuplicatedThrows()
boolean	isIgnoreSimpleAccessors()
protected static boolean	isTagRequired(JavaDocLocalInspection.Options options, java.lang.String tag)
void	readSettings(Element node) Read in settings from XML config.
void	registerAdditionalTag(java.lang.String tag)
void	setIgnoreDuplicatedThrows(boolean ignoreDuplicatedThrows)
void	setIgnoreEmptyDescriptions(boolean ignoreEmptyDescriptions)
void	setIgnoreSimpleAccessors(boolean ignoreSimpleAccessors)
void	setPackageOption(java.lang.String modifier, java.lang.String tags)
void	writeSettings(Element node) Store current settings in XML config.

Methods inherited from class com.intellij.codeInspection.LocalInspectionTool

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

Methods inherited from class com.intellij.codeInspection.InspectionProfileEntry

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

Methods inherited from class java.lang.Object

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

Field Detail

SHORT_NAME

public static final java.lang.String SHORT_NAME

See Also:

Constant Field Values

NONE

protected static final java.lang.String NONE

See Also:

Constant Field Values

PACKAGE_LOCAL

protected static final java.lang.String PACKAGE_LOCAL

See Also:

Constant Field Values

PUBLIC

protected static final java.lang.String PUBLIC

See Also:

Constant Field Values

PROTECTED

protected static final java.lang.String PROTECTED

See Also:

Constant Field Values

PRIVATE

protected static final java.lang.String PRIVATE

See Also:

Constant Field Values

PACKAGE_OPTIONS

protected final JavaDocLocalInspection.Options PACKAGE_OPTIONS

MODULE_OPTIONS

protected final JavaDocLocalInspection.Options MODULE_OPTIONS

TOP_LEVEL_CLASS_OPTIONS

public JavaDocLocalInspection.Options TOP_LEVEL_CLASS_OPTIONS

INNER_CLASS_OPTIONS

public JavaDocLocalInspection.Options INNER_CLASS_OPTIONS

METHOD_OPTIONS

public JavaDocLocalInspection.Options METHOD_OPTIONS

FIELD_OPTIONS

public JavaDocLocalInspection.Options FIELD_OPTIONS

IGNORE_DEPRECATED

public boolean IGNORE_DEPRECATED

IGNORE_JAVADOC_PERIOD

public boolean IGNORE_JAVADOC_PERIOD

IGNORE_DUPLICATED_THROWS

@Deprecated
public boolean IGNORE_DUPLICATED_THROWS

Deprecated.

IGNORE_POINT_TO_ITSELF

public boolean IGNORE_POINT_TO_ITSELF

myAdditionalJavadocTags

public java.lang.String myAdditionalJavadocTags

Constructor Detail

JavaDocLocalInspection

public JavaDocLocalInspection()

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.

createAddJavadocFix

protected LocalQuickFix createAddJavadocFix(PsiElement nameIdentifier,
                                            boolean isOnTheFly)

createAddMissingTagFix

protected LocalQuickFix createAddMissingTagFix(java.lang.String tag,
                                               java.lang.String value,
                                               boolean isOnTheFly)

createAddMissingParamTagFix

protected LocalQuickFix createAddMissingParamTagFix(java.lang.String name,
                                                    boolean isOnTheFly)

createRegisterTagFix

protected LocalQuickFix createRegisterTagFix(java.lang.String tag,
                                             boolean isOnTheFly)

setPackageOption

public void setPackageOption(java.lang.String modifier,
                             java.lang.String tags)

registerAdditionalTag

public void registerAdditionalTag(java.lang.String tag)

isIgnoreDuplicatedThrows

public boolean isIgnoreDuplicatedThrows()

setIgnoreDuplicatedThrows

public void setIgnoreDuplicatedThrows(boolean ignoreDuplicatedThrows)

setIgnoreEmptyDescriptions

public void setIgnoreEmptyDescriptions(boolean ignoreEmptyDescriptions)

isIgnoreSimpleAccessors

public boolean isIgnoreSimpleAccessors()

setIgnoreSimpleAccessors

public void setIgnoreSimpleAccessors(boolean ignoreSimpleAccessors)

isEnabledByDefault

public boolean isEnabledByDefault()

Description copied from class: InspectionProfileEntry

DO NOT OVERRIDE this method.

Overrides:

isEnabledByDefault in class InspectionProfileEntry

See Also:

InspectionEP.enabledByDefault

writeSettings

public void writeSettings(Element node)
                   throws WriteExternalException

Description copied from class: InspectionProfileEntry

Store current settings in XML config. Default implementation uses XmlSerializer so you may use public fields (like int TOOL_OPTION) and bean-style getters/setters (like int getToolOption(), void setToolOption(int)) to store your options.

Overrides:

writeSettings in class InspectionProfileEntry

Parameters:

node - to store settings to.

Throws:

WriteExternalException

readSettings

public void readSettings(Element node)
                  throws InvalidDataException

Description copied from class: InspectionProfileEntry

Read in settings from XML config. Default implementation uses XmlSerializer so you may use public fields (like int TOOL_OPTION) and bean-style getters/setters (like int getToolOption(), void setToolOption(int)) to store your options.

Overrides:

readSettings in class InspectionProfileEntry

Parameters:

node - to read settings from.

Throws:

InvalidDataException - if the loaded data was not valid.

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

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

getAlternativeID

public java.lang.String getAlternativeID()

Description copied from class: InspectionProfileEntry

For global tools read-only, for local tools would be used instead getID for modules with alternative classpath storage

Overrides:

getAlternativeID in class LocalInspectionTool

isTagRequired

protected static boolean isTagRequired(JavaDocLocalInspection.Options options,
                                       java.lang.String tag)