javadocs
authorDmitry Avdeev <Dmitry.Avdeev@jetbrains.com>
Thu, 19 Jan 2012 06:39:22 +0000 (10:39 +0400)
committerDmitry Avdeev <Dmitry.Avdeev@jetbrains.com>
Thu, 19 Jan 2012 12:56:54 +0000 (16:56 +0400)
platform/lang-api/src/com/intellij/codeInspection/InspectionEP.java
platform/lang-api/src/com/intellij/codeInspection/InspectionProfileEntry.java

index e802892bc5789f93a3d9a5246fe9048c0f27851a..04a0fbc2e167cbb9ad481851f8dbc51fe17eb17c 100644 (file)
@@ -40,8 +40,14 @@ public class InspectionEP extends LanguageExtensionPoint {
   /** @see GlobalInspectionTool */
   public final static ExtensionPointName<InspectionEP> GLOBAL_INSPECTION = ExtensionPointName.create("com.intellij.globalInspection");
 
+  /**
+   * Short name is used in two cases: \inspectionDescriptions\&lt;short_name&gt;.html resource may contain short inspection
+   * description to be shown in "Inspect Code..." dialog and also provide some file name convention when using offline
+   * inspection or export to HTML function. Should be unique among all inspections.
+   */
   @Attribute("shortName")
   public String shortName;
+
   @Nls
   @NotNull
   public String getDisplayName() {
@@ -92,6 +98,9 @@ public class InspectionEP extends LanguageExtensionPoint {
   @Attribute("applyToDialects")
   public boolean applyToDialects = true;
 
+  /**
+   * Highlighting level for this inspection tool that is used in default settings.
+   */
   @Attribute("level")
   public String level;
 
index 07eab0479b424063d11794e14523eccc3008e11e..6e1e7278c3d0fda0e4564d91ae9a3013e501948f 100644 (file)
@@ -51,9 +51,21 @@ public abstract class InspectionProfileEntry {
   private static Set<String> myBlackList = null;
   private Boolean myUseNewSerializer = null;
 
+  /**
+   * DO NOT OVERRIDE this method.
+   *
+   * @see InspectionEP#groupDisplayName
+   * @see InspectionEP#groupKey
+   * @see InspectionEP#groupBundle
+   */
   @Nls @NotNull
   public abstract String getGroupDisplayName();
 
+  /**
+   * DO NOT OVERRIDE this method.
+   *
+   * @see InspectionEP#groupPath
+   */
   @NotNull
   public String[] getGroupPath() {
     String groupDisplayName = getGroupDisplayName();
@@ -63,14 +75,19 @@ public abstract class InspectionProfileEntry {
     return new String[]{groupDisplayName};
   }
 
+  /**
+   * DO NOT OVERRIDE this method.
+   *
+   * @see InspectionEP#displayName
+   * @see InspectionEP#key
+   * @see InspectionEP#bundle
+   */
   @Nls @NotNull
   public abstract String getDisplayName();
 
   /**
-   * This method is not supposed to be overridden.
-   * @return short name that is used in two cases: \inspectionDescriptions\&lt;short_name&gt;.html resource may contain short inspection
-   *         description to be shown in "Inspect Code..." dialog and also provide some file name convention when using offline
-   *         inspection or export to HTML function. Should be unique among all inspections.
+   * DO NOT OVERRIDE this method.
+   *
    * @see InspectionEP#shortName
    */
   @NonNls @NotNull
@@ -83,13 +100,20 @@ public abstract class InspectionProfileEntry {
   }
 
   /**
-   * @return highlighting level for this inspection tool that is used in default settings.
+   * DO NOT OVERRIDE this method.
+   *
+   * @see InspectionEP#level
    */
   @NotNull
   public HighlightDisplayLevel getDefaultLevel() {
     return HighlightDisplayLevel.WARNING;
   }
 
+  /**
+   * DO NOT OVERRIDE this method.
+   *
+   * @see InspectionEP#enabledByDefault
+   */
   public boolean isEnabledByDefault() {
     return false;
   }