Package com.intellij.codeInsight.editorActions

Class FixDocCommentAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.openapi.editor.actionSystem.EditorAction

com.intellij.codeInsight.editorActions.FixDocCommentAction

All Implemented Interfaces:

LightEditCompatible, UpdateInBackground, DumbAware, PossiblyDumbAware

public class FixDocCommentAction
extends EditorAction

Creates documentation comment for the current context if it's not created yet (e.g. the caret is inside a method which doesn't have a doc comment).

Updates existing documentation comment if necessary if the one exists. E.g. we've changed method signature and want to remove all outdated parameters and create stubs for the new ones.

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.openapi.actionSystem.AnAction

AnAction.TransparentUpdate

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_ID

Fields inherited from class com.intellij.openapi.actionSystem.AnAction

ACTIONS_KEY, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
FixDocCommentAction()

Method Summary

Modifier and Type	Method and Description
static void	generateOrFixComment(PsiElement element, Project project, Editor editor) Generates comment if it's not exist or try to fix if exists

Methods inherited from class com.intellij.openapi.editor.actionSystem.EditorAction

actionPerformed, actionPerformed, beforeActionPerformedUpdate, doSetupHandler, getEditor, getHandler, setInjectedContext, setupHandler, update, update, updateForKeyboardAccess

Methods inherited from class com.intellij.openapi.actionSystem.AnAction

addTextOverride, applyTextOverride, copyFrom, copyShortcutFrom, displayTextInToolbar, getEventProject, getShortcutSet, getTemplatePresentation, getTemplateText, isDefaultIcon, isEnabledInModalContext, isInInjectedContext, isTransparentUpdate, registerCustomShortcutSet, registerCustomShortcutSet, registerCustomShortcutSet, registerCustomShortcutSet, setDefaultIcon, setEnabledInModalContext, setShortcutSet, startInTransaction, toString, unregisterCustomShortcutSet, useSmallerFontForTextInToolbar

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.project.PossiblyDumbAware

isDumbAware

Field Detail

ACTION_ID

public static final java.lang.String ACTION_ID

See Also:

Constant Field Values

Constructor Detail

FixDocCommentAction

public FixDocCommentAction()

Method Detail

generateOrFixComment

public static void generateOrFixComment(PsiElement element,
                                        Project project,
                                        Editor editor)

Generates comment if it's not exist or try to fix if exists

Parameters:

element - target element for which a comment should be generated

project - current project

editor - target editor