From 015c59264261a1d710680f3348c7af17856b984d Mon Sep 17 00:00:00 2001 From: Konstantin Bulenkov Date: Wed, 12 Dec 2012 10:03:24 +0100 Subject: [PATCH] cosmetics --- .../codeInspection/LocalQuickFixBase.java | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/platform/lang-api/src/com/intellij/codeInspection/LocalQuickFixBase.java b/platform/lang-api/src/com/intellij/codeInspection/LocalQuickFixBase.java index 1fd364e65060..315957da3238 100644 --- a/platform/lang-api/src/com/intellij/codeInspection/LocalQuickFixBase.java +++ b/platform/lang-api/src/com/intellij/codeInspection/LocalQuickFixBase.java @@ -25,11 +25,22 @@ public abstract class LocalQuickFixBase implements LocalQuickFix { private final String myName; private final String myFamilyName; - public LocalQuickFixBase(String name) { + /** + * + * @param name the name of the quick fix + */ + protected LocalQuickFixBase(@NotNull String name) { this(name, name); } - public LocalQuickFixBase(String name, String familyName) { + /** + * + * @param name the name of the quick fix + * @param familyName text to appear in "Apply Fix" popup when multiple Quick Fixes exist (in the results of batch code inspection). For example, + * if the name of the quickfix is "Create template <filename>", the return value of getFamilyName() should be "Create template". + * If the name of the quickfix does not depend on a specific element, simply return getName(). + */ + protected LocalQuickFixBase(@NotNull String name, @NotNull String familyName) { myName = name; myFamilyName = familyName; }