MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2025-12-16 22:51:17 +07:00
Code Issues Packages Projects Releases Wiki Activity

cleanup some inspection descriptions (IDEA-251455)

Browse Source 
GitOrigin-RevId: 41a2012998f1342f484ade71639f587bf11caccc
This commit is contained in:
Bas Leijdekkers
2021-02-09 16:33:27 +01:00
committed by intellij-monorepo-bot
parent 41e0c1e038
commit f2d0ec0156
8 changed files with 22 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
jvm/jvm-analysis-impl/resources/inspectionDescriptions/NonExtendableApiUsage.html
View File

@@ -1,10 +1,8 @@
<html>
<body>
<p>
Reports classes, interfaces and methods that extend, implement or override API elements marked with <code>@ApiStatus.NonExtendable</code>
Reports classes, interfaces and methods that extend, implement or override API elements marked with an <code>@ApiStatus.NonExtendable</code>
annotation.
</p>
<code>@ApiStatus.NonExtendable</code> annotation indicates that the annotated API class, interface or method <strong>must not be extended,
An <code>@ApiStatus.NonExtendable</code> annotation indicates that the annotated API class, interface or method <strong>must not be extended,
implemented or overridden</strong>. Instances of classes and interfaces marked with this annotation may be cast to an internal
implementing class in the library code,
leading to <code>ClassCastException</code> if a different implementation is provided by client. New abstract methods may be added to such

8
jvm/jvm-analysis-impl/resources/inspectionDescriptions/OverrideOnly.html
View File

@@ -1,10 +1,8 @@
<html>
<body>
<p>
Reports invocations of API methods marked with <code>@ApiStatus.OverrideOnly</code> annotation.
</p>
<code>@ApiStatus.OverrideOnly</code> indicates that the annotated method is part of SPI (Service Provider Interface),
Reports calls to API methods marked with an <code>@ApiStatus.OverrideOnly</code> annotation.
An <code>@ApiStatus.OverrideOnly</code> indicates that the annotated method is part of SPI (Service Provider Interface),
which is intended to be <strong>only implemented or overridden</strong> but not called by clients of the declaring library.
If a class or interface is marked with this annotation it means that all its methods can be only overridden.
If a class or interface is marked with this annotation, it means that all its methods can be only overridden.
</body>
</html>

4
jvm/jvm-analysis-impl/resources/inspectionDescriptions/UnstableApiUsage.html
View File

@@ -1,5 +1,7 @@
<html>
<body>
Reports usages of API marked with "unstable" annotations from the list below.
Reports usages of API marked as unstable with an annotation.
<!-- tooltip end -->
Use the list below to specify the annotations which mark an unstable API.
</body>
</html>

8
jvm/jvm-analysis-impl/resources/inspectionDescriptions/UnstableTypeUsedInSignature.html
View File

@@ -1,11 +1,11 @@
<html>
<body>
<p>
Reports declarations of classes, methods and fields that reference an unstable API type in the signature
but are not marked with the same unstable annotation. Set of checked annotations' names is specified below.
</p>
Reports declarations of classes, methods and fields that reference an unstable API type in the signature,
but are not marked with the same unstable annotation.
This inspection may be useful to check that no <i>unstable (internal, experimental)</i> types are exposed in signatures of public API.
For example, if an <i>experimental</i> class is used as the return type of a method, the method is also considered <i>experimental</i>
because incompatible changes of the type (deletion or move to another package) lead to incompatible method signature changes.
<!-- tooltip end -->
Use the list below to specify the annotations which mark an unstable API.
</body>
</html>

5
plugins/InspectionGadgets/src/inspectionDescriptions/MetaAnnotationWithoutRuntimeRetention.html
View File

@@ -1,7 +1,8 @@
<html>
<body>
<p>Report meta annotations which are used by frameworks by reflection but their retention policy is not RUNTIME.
If retention policy is missed, then default retention policy 'CLASS' would be used, which means that annotations by default are not visible at runtime</p>
Reports meta annotations which are used via reflection by frameworks, but their retention policy is not RUNTIME.
If a retention policy is not specified, then the default retention policy 'CLASS' will be used.
Such annotations will not be visible at runtime.
<!-- tooltip end -->
<p><small>New in 2017.2</small></p>
</body>

5
plugins/InspectionGadgets/src/inspectionDescriptions/PointlessNullCheck.html
View File

@@ -1,8 +1,7 @@
<html>
<body>
<p>Reports a <b>null</b> check followed by a method call that will definitely return <b>false</b> when <b>null</b> is passed (e.g. <b>Class.isInstance</b>).
Such a check seems excessive as the method call always returns <b>false</b>.
</p>
Reports a <b>null</b> check followed by a method call that will definitely return <b>false</b> when <b>null</b> is passed (e.g. <b>Class.isInstance</b>).
Such a check seems excessive as the method call will always return <b>false</b> in this case.
<p>Here is an example of a violation: </p>
<pre><code> if (x != null && myClass.isInstance(x)) { ... }</code></pre>
<p>The quickfix changes this code to:</p>

23
xml/relaxng/src/inspectionDescriptions/UnresolvedReference.html
View File

@@ -1,25 +1,6 @@
<html>
<head>
<style type="text/css">
body, table {
font-family: Verdana, sans-serif;
font-size: 100%;
padding-left: 2mm;
}
#footer {
font-size: 95%;
padding-top: 10px;
}
</style>
</head>
<body>
<p>
This inspections checks for any unresolved references to named patterns ("define") in a RELAX-NG file in XML Syntax.
For unresolved references, a QuickFix is offered to create a corresponding define-element.
</p>
<p id="footer">Powered by RELAX-NG Support</p>
Reports any unresolved references to named patterns ("define") in RELAX-NG files using the XML Syntax.
For unresolved references, a quick fix is offered to create a corresponding define-element.
</body>
</html>

24
xml/relaxng/src/inspectionDescriptions/UnusedDefine.html
View File

@@ -1,26 +1,6 @@
<html>
<head>
<style type="text/css">
body, table {
font-family: Verdana, sans-serif;
font-size: 100%;
padding-left: 2mm;
}
#footer {
font-size: 95%;
padding-top: 10px;
}
</style>
</head>
<body>
<p>
This inspections checks for any unused named patterns ("define") in a RELAX-NG file (XML or Compact Syntax) and
highlights them as unused symbols. This is done with respect to includes from other files, i.e. a define is not
marked as unused if it is used through an include in another file.
</p>
<p id="footer">Powered by RELAX-NG Support</p>
Reports unused named patterns ("define") in a RELAX-NG file (XML or Compact Syntax).
A define will not be marked as unused if it is used through an include in another file.
</body>
</html>