MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-10-06 06:21:16 +07:00
Code Issues Packages Projects Releases Wiki Activity

LineMarkerProvider: javadoc formatting

Browse Source
This commit is contained in:
Yann Cébron
2015-03-11 12:05:04 +01:00
parent e7bb92c604
commit 9498a1bdd7
1 changed files with 19 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
platform/lang-api/src/com/intellij/codeInsight/daemon/LineMarkerProvider.java
+19 -14
View File
@@ -27,27 +27,32 @@ import java.util.List;
* @author yole
*/
public interface LineMarkerProvider {
@Nullable
/**
* Get line markers for this PsiElement.
*
* <p/>
* NOTE for implementers:
* Please return line marker info for exact element you were asked for.
* For example, do not return class marker info if getLineMarkerInfo() was called for a method.
* For example, do not return class marker info if getLineMarkerInfo() was called for a method.
* Please return relevant line marker info for as small element as possible.
* For example, do not return method marker for PsiMethod. Instead, return it for the PsiIdentifier which is a name of this method.
*
* For example, do not return method marker for PsiMethod. Instead, return it for the PsiIdentifier which is a name of this method.
* <p/>
* More technical details:
* Inspection (specifically, LineMarkersPass) for performance reasons queries all LineMarkerProviders in two passes:
* - first pass for all elements in visible area
* - second pass for all the rest elements
* If providers return nothing for either area, its line markers are cleared.
* So if, for example a method, is half-visible (e.g. its name is visible but a part of its body isn't) and
* some poorly written LineMarkerProvider returns info for the PsiMethod instead of PsiIdentifier then following happens:
* - the first pass removes line marker info because whole PsiMethod is not visible.
* - the second pass tries to add line marker info back because LineMarkerProvider is called for the PsiMethod at last.
* As a result, line marker icon blinks annoyingly.
* Inspection (specifically, LineMarkersPass) for performance reasons queries all LineMarkerProviders in two passes:
* <ul>
* <li>first pass for all elements in visible area</li>
* <li>second pass for all the rest elements</li>
* </ul>
* If providers return nothing for either area, its line markers are cleared.
* <p/>
* So if, for example a method, is half-visible (e.g. its name is visible but a part of its body isn't) and
* some poorly written LineMarkerProvider returns info for the PsiMethod instead of PsiIdentifier then following happens:
* <ul>
* <li>the first pass removes line marker info because whole PsiMethod is not visible</li>
* <li>the second pass tries to add line marker info back because LineMarkerProvider is called for the PsiMethod at last</li>
* </ul>
* As a result, line marker icon blinks annoyingly.
*/
@Nullable
LineMarkerInfo getLineMarkerInfo(@NotNull PsiElement element);
void collectSlowLineMarkers(@NotNull List<PsiElement> elements, @NotNull Collection<LineMarkerInfo> result);