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

Fix most of JavaDoc <-> code mismatch warnings

Browse Source 
GitOrigin-RevId: 9a87a8b90993b56cd045722734c5c5f466601ae3
This commit is contained in:
Tagir Valeev
2022-06-20 10:46:00 +02:00
committed by intellij-monorepo-bot
parent c218174085
commit 11595f3956
47 changed files with 131 additions and 129 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
java/compiler/openapi/src/com/intellij/openapi/compiler/CompileScope.java
View File

@@ -41,7 +41,7 @@ public interface CompileScope extends ExportableUserDataHolder {
* @param fileType the type of the files. Null should be passed if all available files are needed.
* @param inSourceOnly if true, files are searched only in directories within the scope that are marked as "sources" or "test sources" in module settings.
* Otherwise files are searched in all directories that belong to the scope.
* @return a list of files of given type that belong to this scope.
* @return a array of files of given type that belong to this scope.
*/
VirtualFile @NotNull [] getFiles(@Nullable FileType fileType, boolean inSourceOnly);
@@ -57,7 +57,7 @@ public interface CompileScope extends ExportableUserDataHolder {
/**
* Returns the list of modules files in which belong to the scope.
*
* @return a list of modules this scope affects.
* @return a array of modules this scope affects.
*/
Module @NotNull [] getAffectedModules();

4
java/java-analysis-api/src/com/intellij/codeInspection/reference/RefMethod.java
View File

@@ -129,12 +129,12 @@ public interface RefMethod extends RefJavaElement, RefOverridable {
/**
* Returns the list of exceptions which are included in the {@code throws} list
* of the method but cannot be actually thrown.
*
* <p>
* To return valid results, requires com.intellij.codeInspection.unneededThrows.RedundantThrowsGraphAnnotator.
* (Dbl) Annotator registration is possible in {@link GlobalInspectionTool#initialize(com.intellij.codeInspection.GlobalInspectionContext)}
* or {@link GlobalInspectionTool#getAnnotator(RefManager)}
*
* @return the list of exceptions declared but not thrown, or null if there are no
* @return the array of exceptions declared but not thrown, or null if there are no
* such exceptions.
*/
PsiClass @Nullable [] getUnThrownExceptions();

2
java/java-analysis-impl/src/com/intellij/codeInspection/dataFlow/jvm/SpecialField.java
View File

@@ -390,7 +390,7 @@ public enum SpecialField implements DerivedVariableDescriptor {
}
/**
* @return a list of method contracts which equivalent to checking this special field for zero
* @return a array of method contracts which equivalent to checking this special field for zero
*/
public MethodContract[] getEmptyContracts() {
ContractValue thisValue = ContractValue.qualifier().specialField(this);

7
java/java-analysis-impl/src/com/intellij/codeInspection/unneededThrows/RedundantThrowsDeclarationLocalInspection.java
View File

@@ -232,8 +232,7 @@ public final class RedundantThrowsDeclarationLocalInspection extends AbstractBas
private static boolean isParentInThrowsListPresent(@NotNull final PsiClass clazz,
@NotNull final List<PsiClassType> throwsList) {
final PsiClassType type = PsiTypesUtil.getClassType(clazz);
return throwsList.stream()
.anyMatch(e -> e.isAssignableFrom(type));
return ContainerUtil.exists(throwsList, e -> e.isAssignableFrom(type));
}
/**
@@ -241,7 +240,7 @@ public final class RedundantThrowsDeclarationLocalInspection extends AbstractBas
*
* @param throwsList throws list of a method
* @param currentRef the currently eliminated throws declaration in the throws list
* @return the set of throws declarations as strings from the throws list excluding the currently eliminated throws declaration
* @return the list of throws declarations as strings from the throws list excluding the currently eliminated throws declaration
*/
private static List<PsiClassType> getThrowsListWithoutCurrent(@NotNull final PsiReferenceList throwsList,
@NotNull final PsiJavaCodeReferenceElement currentRef) {
@@ -313,7 +312,7 @@ public final class RedundantThrowsDeclarationLocalInspection extends AbstractBas
final Set<PsiClassType> unhandled = RedundantThrowsGraphAnnotator.getUnhandledExceptions(body, method, containingClass);
return unhandled.stream().anyMatch(myType::isAssignableFrom);
return ContainerUtil.exists(unhandled, myType::isAssignableFrom);
}
@Contract(pure = true)

4
java/java-impl/src/com/intellij/psi/impl/source/codeStyle/javadoc/JDParser.java
View File

@@ -263,7 +263,7 @@ public class JDParser {
* @param markers if this parameter is not null then it will be filled with Boolean values:
* true if the corresponding line in returned list is inside &lt;pre&gt; tag,
* false if it is outside
* @return array of strings (lines)
* @return list of strings (lines)
*/
@Nullable
private List<String> toArray(@Nullable String s, @Nullable List<Boolean> markers) {
@@ -446,7 +446,7 @@ public class JDParser {
*
* @param s the specified string
* @param width width of the wrapped text
* @return array of strings (lines)
* @return list of strings (lines)
*/
@Contract("null, _ -> null")
private List<String> toArrayWrapping(@Nullable String s, int width) {

32
java/java-indexing-api/src/com/intellij/psi/search/PsiShortNamesCache.java
View File

@@ -32,38 +32,38 @@ public abstract class PsiShortNamesCache {
public static final ExtensionPointName<PsiShortNamesCache> EP_NAME = ExtensionPointName.create("com.intellij.java.shortNamesCache");
/**
* Returns the list of files with the specified name.
* Returns the array of files with the specified name.
*
* @param name the name of the files to find.
* @return the list of files in the project which have the specified name.
* @return the array of files in the project which have the specified name.
*/
public PsiFile @NotNull [] getFilesByName(@NotNull String name) {
return PsiFile.EMPTY_ARRAY;
}
/**
* Returns the list of names of all files in the project.
* Returns the array of names of all files in the project.
*
* @return the list of all file names in the project.
* @return the array of all file names in the project.
*/
public String @NotNull [] getAllFileNames() {
return ArrayUtilRt.EMPTY_STRING_ARRAY;
}
/**
* Returns the list of all classes with the specified name in the specified scope.
* Returns the array of all classes with the specified name in the specified scope.
*
* @param name the non-qualified name of the classes to find.
* @param scope the scope in which classes are searched.
* @return the list of found classes.
* @return the array of found classes.
*/
public abstract @NotNull PsiClass @NotNull [] getClassesByName(@NotNull @NonNls String name, @NotNull GlobalSearchScope scope);
/**
* Returns the list of names of all classes in the project and
* Returns the array of names of all classes in the project and
* (optionally) libraries.
*
* @return the list of all class names.
* @return the array of all class names.
*/
public abstract @NotNull String @NotNull [] getAllClassNames();
@@ -76,11 +76,11 @@ public abstract class PsiShortNamesCache {
}
/**
* Returns the list of all methods with the specified name in the specified scope.
* Returns the array of all methods with the specified name in the specified scope.
*
* @param name the name of the methods to find.
* @param scope the scope in which methods are searched.
* @return the list of found methods.
* @return the array of found methods.
*/
public abstract @NotNull PsiMethod @NotNull [] getMethodsByName(@NonNls @NotNull String name, @NotNull GlobalSearchScope scope);
@@ -108,27 +108,27 @@ public abstract class PsiShortNamesCache {
}
/**
* Returns the list of names of all methods in the project and
* Returns the array of names of all methods in the project and
* (optionally) libraries.
*
* @return the list of all method names.
* @return the array of all method names.
*/
public abstract @NotNull String @NotNull [] getAllMethodNames();
/**
* Returns the list of all fields with the specified name in the specified scope.
* Returns the array of all fields with the specified name in the specified scope.
*
* @param name the name of the fields to find.
* @param scope the scope in which fields are searched.
* @return the list of found fields.
* @return the array of found fields.
*/
public abstract @NotNull PsiField @NotNull [] getFieldsByName(@NotNull @NonNls String name, @NotNull GlobalSearchScope scope);
/**
* Returns the list of names of all fields in the project and
* Returns the array of names of all fields in the project and
* (optionally) libraries.
*
* @return the list of all field names.
* @return the array of all field names.
*/
public abstract @NotNull String @NotNull [] getAllFieldNames();

2
java/java-psi-api/src/com/intellij/lang/jvm/facade/JvmFacade.java
View File

@@ -40,7 +40,7 @@ public interface JvmFacade {
*
* @param qualifiedName the full-qualified name of the class to find.
* @param scope the scope to search.
* @return the array of found classes, or an empty array if no classes are found.
* @return the list of found classes, or an empty array if no classes are found.
*/
@NotNull
List<? extends JvmClass> findClasses(@NonNls @NotNull String qualifiedName, @NotNull GlobalSearchScope scope);

2
java/java-psi-api/src/com/intellij/openapi/roots/PackageIndex.java
View File

@@ -23,7 +23,7 @@ public abstract class PackageIndex {
*
* @param packageName the name of the package for which directories are requested.
* @param includeLibrarySources if true, directories under library sources are included in the returned list.
* @return the list of directories.
* @return the array of directories.
*/
public abstract VirtualFile @NotNull [] getDirectoriesByPackageName(@NotNull String packageName, boolean includeLibrarySources);

4
java/java-psi-api/src/com/intellij/psi/PsiAnnotationOwner.java
View File

@@ -9,12 +9,12 @@ public interface PsiAnnotationOwner {
/**
* Returns the list of annotations syntactically contained in the element.
*
* @return the list of annotations.
* @return the array of annotations.
*/
PsiAnnotation @NotNull [] getAnnotations();
/**
* @return the list of annotations which are applicable to this owner
* @return the array of annotations which are applicable to this owner
* (e.g. type annotations on method belong to its type element, not the method).
*/
PsiAnnotation @NotNull [] getApplicableAnnotations();

2
java/java-psi-api/src/com/intellij/psi/PsiCaseLabelElementList.java
View File

@@ -8,7 +8,7 @@ import org.jetbrains.annotations.NotNull;
*/
public interface PsiCaseLabelElementList extends PsiElement {
/**
* @return list of the elements contained in the list
* @return array of the elements contained in the list
*/
PsiCaseLabelElement @NotNull [] getElements();

56
java/java-psi-api/src/com/intellij/psi/PsiClass.java
View File

@@ -88,16 +88,16 @@ public interface PsiClass
PsiReferenceList getImplementsList();
/**
* Returns the list of class types for the classes that this class or interface extends.
* Returns the array of class types for the classes that this class or interface extends.
*
* @return the list of extended class types, or an empty list for anonymous classes.
* @return the array of extended class types, or an empty list for anonymous classes.
*/
PsiClassType @NotNull [] getExtendsListTypes();
/**
* Returns the list of class types for the interfaces that this class implements.
* Returns the array of class types for the interfaces that this class implements.
*
* @return the list of extended class types, or an empty list for anonymous classes,
* @return the array of extended class types, or an empty list for anonymous classes,
* enums and annotation types
*/
PsiClassType @NotNull [] getImplementsListTypes();
@@ -113,9 +113,9 @@ public interface PsiClass
}
/**
* Returns the list of class types that this class or interface explicitly permits.
* Returns the array of class types that this class or interface explicitly permits.
*
* @return the list of explicitly permitted classes.
* @return the array of explicitly permitted classes.
*/
default PsiClassType @NotNull [] getPermitsListTypes() {
PsiReferenceList permitsList = getPermitsList();
@@ -135,86 +135,86 @@ public interface PsiClass
PsiClass getSuperClass();
/**
* Returns the list of interfaces implemented by the class, or extended by the interface.
* Returns the array of interfaces implemented by the class, or extended by the interface.
*
* @return the list of interfaces.
* @return the array of interfaces.
*/
PsiClass @NotNull [] getInterfaces();
/**
* Returns the list of classes and interfaces extended or implemented by the class.
* Returns the array of classes and interfaces extended or implemented by the class.
*
* @return the list of classes or interfaces. May return zero elements when jdk is
* @return the array of classes or interfaces. May return zero elements when jdk is
* not configured, so no java.lang.Object is found
*/
PsiClass @NotNull [] getSupers();
/**
* Returns the list of class types for the classes and interfaces extended or
* Returns the array of class types for the classes and interfaces extended or
* implemented by the class.
*
* @return the list of class types for the classes or interfaces.
* @return the array of class types for the classes or interfaces.
* For the class with no explicit extends list, the returned list always contains at least one element for the java.lang.Object type.
* If psiClass is java.lang.Object, returned list is empty.
*/
PsiClassType @NotNull [] getSuperTypes();
/**
* Returns the list of fields in the class.
* Returns the array of fields in the class.
*
* @return the list of fields.
* @return the array of fields.
*/
@Override
PsiField @NotNull [] getFields();
/**
* Returns the list of methods in the class.
* Returns the array of methods in the class.
*
* @return the list of methods.
* @return the array of methods.
*/
@Override
PsiMethod @NotNull [] getMethods();
/**
* Returns the list of constructors for the class.
* Returns the array of constructors for the class.
*
* @return the list of constructors,
* @return the array of constructors,
*/
PsiMethod @NotNull [] getConstructors();
/**
* Returns the list of inner classes for the class.
* Returns the array of inner classes for the class.
*
* @return the list of inner classes.
* @return the array of inner classes.
*/
@Override
PsiClass @NotNull [] getInnerClasses();
/**
* Returns the list of class initializers for the class.
* Returns the array of class initializers for the class.
*
* @return the list of class initializers.
* @return the array of class initializers.
*/
PsiClassInitializer @NotNull [] getInitializers();
/**
* Returns the list of fields in the class and all its superclasses.
* Returns the array of fields in the class and all its superclasses.
*
* @return the list of fields.
* @return the array of fields.
*/
PsiField @NotNull [] getAllFields();
/**
* Returns the list of methods in the class and all its superclasses.
* Returns the array of methods in the class and all its superclasses.
*
* @return the list of methods.
* @return the array of methods.
*/
PsiMethod @NotNull [] getAllMethods();
/**
* Returns the list of inner classes for the class and all its superclasses.
* Returns the array of inner classes for the class and all its superclasses.
*
* @return the list of inner classes.
* @return the array of inner classes.
*/
PsiClass @NotNull [] getAllInnerClasses();

16
java/java-psi-api/src/com/intellij/psi/PsiElementFinder.java
View File

@@ -61,11 +61,11 @@ public abstract class PsiElementFinder {
}
/**
* Returns the list of subpackages of the specified package in the specified search scope.
* Returns the array of subpackages of the specified package in the specified search scope.
*
* @param psiPackage the package to return the list of subpackages for.
* @param scope the scope in which subpackages are searched.
* @return the list of subpackages.
* @return the array of subpackages.
* @see PsiPackage#getSubPackages(GlobalSearchScope)
*/
public PsiPackage @NotNull [] getSubPackages(@NotNull PsiPackage psiPackage, @NotNull GlobalSearchScope scope) {
@@ -73,11 +73,11 @@ public abstract class PsiElementFinder {
}
/**
* Returns the list of classes in the specified package and in the specified search scope.
* Returns the array of classes in the specified package and in the specified search scope.
*
* @param psiPackage the package to return the list of classes in.
* @param scope the scope in which classes are searched.
* @return the list of classes.
* @return the array of classes.
* @see PsiPackage#getClasses(GlobalSearchScope)
*/
public PsiClass @NotNull [] getClasses(@NotNull PsiPackage psiPackage, @NotNull GlobalSearchScope scope) {
@@ -95,11 +95,11 @@ public abstract class PsiElementFinder {
}
/**
* Returns a list of files belonging to the specified package which are not located in any of the package directories.
* Returns a array of files belonging to the specified package which are not located in any of the package directories.
*
* @param psiPackage the package to return the list of files for.
* @param scope the scope in which files are searched.
* @return the list of files.
* @return the array of files.
*/
public PsiFile @NotNull [] getPackageFiles(@NotNull PsiPackage psiPackage, @NotNull GlobalSearchScope scope) {
return PsiFile.EMPTY_ARRAY;
@@ -155,12 +155,12 @@ public abstract class PsiElementFinder {
}
/**
* Returns the list of classes in the specified package and in the specified search scope.
* Returns the array of classes in the specified package and in the specified search scope.
*
* @param className short name of the class
* @param psiPackage the package to return the list of classes in.
* @param scope the scope in which classes are searched.
* @return the list of classes.
* @return the array of classes.
* @see PsiPackage#getClasses(GlobalSearchScope)
*/
public PsiClass @NotNull [] getClasses(@Nullable String className, @NotNull PsiPackage psiPackage, @NotNull GlobalSearchScope scope) {

16
java/java-psi-api/src/com/intellij/psi/PsiJavaFile.java
View File

@@ -50,37 +50,37 @@ public interface PsiJavaFile extends PsiImportHolder, PsiClassOwner {
PsiImportList getImportList();
/**
* Returns the list of classes or packages which have been
* Returns the array of classes or packages which have been
* imported on demand (for example, javax.swing.*)
*
* @param includeImplicit if true, implicitly imported packages (like java.lang) are included.
* @param checkIncludes deprecated, no longer used
* @return the list of PsiClass or PsiPackage elements for the imports.
* @return the array of PsiClass or PsiPackage elements for the imports.
*/
PsiElement @NotNull [] getOnDemandImports(boolean includeImplicit, @Deprecated boolean checkIncludes);
/**
* Returns the list of classes which have been imported as
* Returns the array of classes which have been imported as
* single-class imports.
*
* @param checkIncludes deprecated, no longer used.
* @return the list of PsiClass elements for the import.
* @return the array of PsiClass elements for the import.
*/
PsiClass @NotNull [] getSingleClassImports(@Deprecated boolean checkIncludes);
/**
* Returns the list of names of implicitly imported packages
* Returns the array of names of implicitly imported packages
* (for example, java.lang).
*
* @return the list of implicitly imported package names.
* @return the array of implicitly imported package names.
*/
String @NotNull [] getImplicitlyImportedPackages();
/**
* returns the list of reference elements for the
* returns the array of reference elements for the
* implicitly imported packages (for example, java.lang).
*
* @return the list of implicitly imported package reference elements.
* @return the array of implicitly imported package reference elements.
*/
PsiJavaCodeReferenceElement @NotNull [] getImplicitlyImportedPackageReferences();

2
java/java-psi-api/src/com/intellij/psi/PsiMethod.java
View File

@@ -153,7 +153,7 @@ public interface PsiMethod extends PsiMember, PsiNameIdentifierOwner, PsiModifie
*
* @param checkAccess if false, the super methods are searched even if this method
* is private. If true, an empty result list is returned for private methods.
* @return the array of matching method signatures, or an empty array if no methods are found.
* @return the list of matching method signatures, or an empty array if no methods are found.
*/
@NotNull
List<MethodSignatureBackedByPsiMethod> findSuperMethodSignaturesIncludingStatic(boolean checkAccess);

2
java/java-psi-api/src/com/intellij/psi/javadoc/PsiSnippetAttributeList.java
View File

@@ -13,7 +13,7 @@ import org.jetbrains.annotations.NotNull;
@ApiStatus.Experimental
public interface PsiSnippetAttributeList extends PsiElement {
/**
* @return list of name-value pairs of snippet tag.
* @return array of name-value pairs of snippet tag.
*/
PsiSnippetAttribute @NotNull [] getAttributes();
}

9
jvm/jvm-analysis-api/src/com/intellij/codeInspection/blockingCallsDetection/NonBlockingContextChecker.java
View File

@@ -1,6 +1,8 @@
// Copyright 2000-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package com.intellij.codeInspection.blockingCallsDetection;
import com.intellij.codeInspection.blockingCallsDetection.ContextType.Blocking;
import com.intellij.codeInspection.blockingCallsDetection.ContextType.NonBlocking;
import com.intellij.openapi.extensions.ExtensionPointName;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiFile;
@@ -22,14 +24,15 @@ public interface NonBlockingContextChecker {
/**
* @param elementContext metadata that provides info about inspection settings and PsiElement (e.g. method call or reference)
* to check if it is placed in code fragment where thread block is not allowed
* @return true if code fragment for {@code element} is considered "non-blocking", false otherwise
* @return {@link NonBlocking#INSTANCE} if code fragment for {@code element} is considered "non-blocking",
* {@link Blocking#INSTANCE} otherwise
*/
default ContextType computeContextType(@NotNull ElementContext elementContext) {
if (isContextNonBlockingFor(elementContext.getElement())) {
return ContextType.NonBlocking.INSTANCE;
return NonBlocking.INSTANCE;
}
else {
return ContextType.Blocking.INSTANCE;
return Blocking.INSTANCE;
}
}

2
platform/analysis-api/src/com/intellij/codeInsight/intention/IntentionManager.java
View File

@@ -56,7 +56,7 @@ public abstract class IntentionManager {
* Returns all registered intention actions which are available now
* (not disabled via Settings|Intentions or Alt-Enter|Disable intention quick fix)
*
* @return array of actions.
* @return list of actions.
*/
public abstract @NotNull List<IntentionAction> getAvailableIntentions();

2
platform/analysis-api/src/com/intellij/codeInspection/BatchSuppressableTool.java
View File

@@ -34,7 +34,7 @@ public interface BatchSuppressableTool {
*
* @param element the element on which Alt-Enter is pressed, or null if getting the list of available suppression actions in
* Inspections tool window
* @return the list of suppression actions.
* @return the array of suppression actions.
*/
SuppressQuickFix @NotNull [] getBatchSuppressActions(@Nullable final PsiElement element);

2
platform/analysis-api/src/com/intellij/codeInspection/CommonProblemDescriptor.java
View File

@@ -53,7 +53,7 @@ public interface CommonProblemDescriptor {
/**
* Returns the quickfixes for the problem.
*
* @return the list of quickfixes registered for the problem.
* @return the array of quickfixes registered for the problem.
*/
QuickFix @Nullable [] getFixes();
}

2
platform/analysis-api/src/com/intellij/codeInspection/CustomSuppressableInspectionTool.java
View File

@@ -32,7 +32,7 @@ public interface CustomSuppressableInspectionTool {
*
* @param element the element on which Alt-Enter is pressed, or null if getting the list of available suppression actions in
* Inspections tool window
* @return the list of suppression actions.
* @return the array of suppression actions.
*/
SuppressIntentionAction @Nullable [] getSuppressActions(@Nullable final PsiElement element);

2
platform/analysis-api/src/com/intellij/codeInspection/SuppressableProblemGroup.java
View File

@@ -30,7 +30,7 @@ public interface SuppressableProblemGroup extends ProblemGroup {
*
* @param element the element on which Alt-Enter is pressed, or null if getting the list of available suppression actions in
* Inspections tool window
* @return the list of suppression actions.
* @return the array of suppression actions.
*/
SuppressIntentionAction @NotNull [] getSuppressActions(@Nullable final PsiElement element);
}

2
platform/analysis-impl/src/com/intellij/codeInspection/dataFlow/value/DfaControlTransferValue.java
View File

@@ -74,7 +74,7 @@ public final class DfaControlTransferValue extends DfaValue {
*/
public interface TransferTarget {
/**
* @return list of possible instruction offsets for given target
* @return array of possible instruction offsets for given target
*/
default int @NotNull [] getPossibleTargets() {
return ArrayUtil.EMPTY_INT_ARRAY;

4
platform/core-api/src/com/intellij/psi/PsiDocumentManager.java
View File

@@ -135,9 +135,9 @@ public abstract class PsiDocumentManager {
public abstract Document getLastCommittedDocument(@NotNull PsiFile file);
/**
* Returns the list of documents which have been modified but not committed.
* Returns the array of documents which have been modified but not committed.
*
* @return the list of uncommitted documents.
* @return the array of uncommitted documents.
* @see #commitDocument(Document)
*/
public abstract @NotNull Document @NotNull [] getUncommittedDocuments();

2
platform/editor-ui-api/src/com/intellij/ide/structureView/TextEditorBasedStructureViewModel.java
View File

@@ -161,7 +161,7 @@ public abstract class TextEditorBasedStructureViewModel implements StructureView
* When determining the current editor element, the PSI tree is walked up until an element
* matching one of these classes is found.
*
* @return the list of classes
* @return the array of classes
*/
protected Class @NotNull [] getSuitableClasses() {
return ArrayUtil.EMPTY_CLASS_ARRAY;

4
platform/editor-ui-api/src/com/intellij/ide/util/treeView/smartTree/TreeElement.java
View File

@@ -21,9 +21,9 @@ public interface TreeElement {
ItemPresentation getPresentation();
/**
* Returns the list of children of the tree element.
* Returns the array of children of the tree element.
*
* @return the list of children.
* @return the array of children.
*/
TreeElement @NotNull [] getChildren();
}

2
platform/execution/src/com/intellij/execution/ExecutionResult.java
View File

@@ -37,7 +37,7 @@ public interface ExecutionResult {
/**
* Returns the actions to display in the toolbar of the Run/Debug console tab.
*
* @return the list of toolbar actions to display.
* @return the array of toolbar actions to display.
*/
AnAction @NotNull [] getActions();

4
platform/indexing-api/src/com/intellij/psi/search/PsiSearchHelper.java
View File

@@ -73,11 +73,11 @@ public interface PsiSearchHelper {
@NotNull Processor<? super VirtualFile> processor);
/**
* Returns the list of files which contain the specified word in "plain text"
* Returns the array of files which contain the specified word in "plain text"
* context (for example, plain text files or attribute values in XML files).
*
* @param word the word to search.
* @return the list of files containing the word.
* @return the array of files containing the word.
*/
PsiFile @NotNull [] findFilesWithPlainTextWords(@NotNull String word);

4
platform/indexing-api/src/com/intellij/psi/search/PsiTodoSearchHelper.java
View File

@@ -29,9 +29,9 @@ public interface PsiTodoSearchHelper {
}
/**
* Returns the list of all files in the project which have to do items.
* Returns the array of all files in the project which have to do items.
*
* @return the list of files with to do items.
* @return the array of files with to do items.
* @deprecated Use {@link #processFilesWithTodoItems(Processor)} instead.
*/
@Deprecated

4
platform/lang-api/src/com/intellij/lang/surroundWith/SurroundDescriptor.java
View File

@@ -17,7 +17,7 @@ import org.jetbrains.annotations.NotNull;
*/
public interface SurroundDescriptor {
/**
* Returns the list of elements which will be included in the surrounded region for
* Returns the array of elements which will be included in the surrounded region for
* the specified selection in the specified file, or an empty array if no surrounders
* from this surround descriptor are applicable to the specified selection.
*
@@ -29,7 +29,7 @@ public interface SurroundDescriptor {
PsiElement @NotNull [] getElementsToSurround(PsiFile file, int startOffset, int endOffset);
/**
* @return the list of surrounders (surround templates) which can be used for this code fragment type
* @return the array of surrounders (surround templates) which can be used for this code fragment type
*/
Surrounder @NotNull [] getSurrounders();

2
platform/lang-api/src/com/intellij/navigation/ChooseByNameRegistry.java
View File

@@ -33,7 +33,7 @@ public final class ChooseByNameRegistry {
/**
* Returns the list of registered contributors for the "Goto Symbol" list.
*
* @return the array of contributors.
* @return the list of contributors.
*/
public List<ChooseByNameContributor> getSymbolModelContributors() {
return ChooseByNameContributor.SYMBOL_EP_NAME.getExtensionList();

2
platform/lang-core/src/com/intellij/ide/IdeView.java
View File

@@ -40,7 +40,7 @@ public interface IdeView {
* Returns the list of directories corresponding to the element currently selected in the view.
* Can return a list of multiple elements if a package is selected.
*
* @return the list of directories, or an empty array if nothing is selected.
* @return the array of directories, or an empty array if nothing is selected.
*/
PsiDirectory @NotNull [] getDirectories();

2
platform/lang-impl/src/com/intellij/ide/util/gotoByName/ContributorsBasedGotoByModel.java
View File

@@ -252,7 +252,7 @@ public abstract class ContributorsBasedGotoByModel implements ChooseByNameModelE
* @param name a name
* @param checkBoxState if {@code true}, non-project files are considered as well
* @param pattern a pattern to use
* @return a list of navigation items from contributors for
* @return a array of navigation items from contributors for
* which {@link #acceptItem(NavigationItem)} returns {@code true}.
*/
@Override

4
platform/platform-api/src/com/intellij/openapi/options/colors/ColorAndFontDescriptorsProvider.java
View File

@@ -35,7 +35,7 @@ public interface ColorAndFontDescriptorsProvider {
* all highlighting attributes (font type, background color, foreground color, error stripe color and
* effects).
*
* @return the list of attribute descriptors.
* @return the array of attribute descriptors.
*/
AttributesDescriptor @NotNull [] getAttributeDescriptors();
@@ -44,7 +44,7 @@ public interface ColorAndFontDescriptorsProvider {
* instances for which colors are specified in the page. For such color keys, the user can
* choose only the background or foreground color.
*
* @return the list of color descriptors.
* @return the array of color descriptors.
*/
ColorDescriptor @NotNull [] getColorDescriptors();

6
platform/platform-api/src/com/intellij/openapi/options/colors/ColorSettingsPages.java
View File

@@ -24,16 +24,16 @@ public abstract class ColorSettingsPages {
* Registers a custom page for the "Colors and Fonts" settings dialog.
*
* @param page the instance of the page to register.
*
* <p>
* Used only in special cases when pages are registered dynamically (Rider).
* Otherwise pages should be registered as extensions with {@link ColorSettingsPage#EP_NAME}
* Otherwise, pages should be registered as extensions with {@link ColorSettingsPage#EP_NAME}
*/
public abstract void registerPage(ColorSettingsPage page);
/**
* Returns the list of all registered pages in the "Colors and Fonts" dialog.
*
* @return the list of registered pages.
* @return the array of registered pages.
*/
public abstract ColorSettingsPage[] getRegisteredPages();

2
platform/platform-impl/src/com/intellij/openapi/fileEditor/impl/EditorHistoryManager.java
View File

@@ -239,7 +239,7 @@ public final class EditorHistoryManager implements PersistentStateComponent<Elem
}
/**
* @return a set of valid files that are in the history, oldest first.
* @return a list of valid files that are in the history, oldest first.
*/
@NotNull
public synchronized List<VirtualFile> getFileList() {

8
platform/projectModel-api/src/com/intellij/openapi/roots/ContentEntry.java
View File

@@ -59,7 +59,7 @@ public interface ContentEntry extends Synthetic {
/**
* Returns the list of source roots under this content root.
*
* @return list of this {@code ContentEntry} {@link SourceFolder}s
* @return array of this {@code ContentEntry} {@link SourceFolder}s
*/
SourceFolder @NotNull [] getSourceFolders();
@@ -81,14 +81,14 @@ public interface ContentEntry extends Synthetic {
/**
* Returns the list of files and directories for valid source roots under this content root.
*
* @return list of all valid source roots.
* @return array of all valid source roots.
*/
VirtualFile @NotNull [] getSourceFolderFiles();
/**
* Returns the list of excluded roots configured under this content root. The result doesn't include synthetic excludes like the module output.
*
* @return list of this {@code ContentEntry} {@link ExcludeFolder}s
* @return array of this {@code ContentEntry} {@link ExcludeFolder}s
*/
ExcludeFolder @NotNull [] getExcludeFolders();
@@ -101,7 +101,7 @@ public interface ContentEntry extends Synthetic {
/**
* Returns the list of files and directories for valid excluded roots under this content root.
*
* @return list of all valid exclude roots including synthetic excludes like the module output
* @return array of all valid exclude roots including synthetic excludes like the module output
*/
VirtualFile @NotNull [] getExcludeFolderFiles();

4
platform/projectModel-api/src/com/intellij/openapi/roots/ModuleRootManager.java
View File

@@ -58,7 +58,7 @@ public abstract class ModuleRootManager implements ModuleRootModel, ProjectModel
* Returns the list of modules on which the current module directly depends. The method does not traverse
* the entire dependency structure - dependencies of dependency modules are not included in the returned list.
*
* @return the list of module direct dependencies.
* @return the array of module direct dependencies.
*/
public abstract Module @NotNull [] getDependencies();
@@ -67,7 +67,7 @@ public abstract class ModuleRootManager implements ModuleRootModel, ProjectModel
* the entire dependency structure - dependencies of dependency modules are not included in the returned list.
*
* @param includeTests whether test-only dependencies should be included
* @return the list of module direct dependencies.
* @return the array of module direct dependencies.
*/
public abstract Module @NotNull [] getDependencies(boolean includeTests);

6
platform/projectModel-api/src/com/intellij/openapi/roots/ModuleRootModel.java
View File

@@ -46,7 +46,7 @@ public interface ModuleRootModel {
* Use this method to obtain all content entries of a module. Entries are given in
* lexicographical order of their paths.
*
* @return list of content entries for this module
* @return array of content entries for this module
* @see ContentEntry
*/
ContentEntry @NotNull [] getContentEntries();
@@ -54,7 +54,7 @@ public interface ModuleRootModel {
/**
* Use this method to obtain order of roots of a module. Order of entries is important.
*
* @return list of order entries for this module
* @return array of order entries for this module
*/
OrderEntry @NotNull [] getOrderEntries();
@@ -184,7 +184,7 @@ public interface ModuleRootModel {
/**
* Returns list of module names <i>this module</i> depends on.
*
* @return the list of module names this module depends on.
* @return the array of module names this module depends on.
*/
String @NotNull [] getDependencyModuleNames();

4
platform/projectModel-api/src/com/intellij/openapi/roots/OrderEntry.java
View File

@@ -44,7 +44,7 @@ public interface OrderEntry extends Synthetic, Comparable<OrderEntry> {
* Note that list of roots is project dependent.
*
* @param type required root type.
* @return list of virtual files.
* @return array of virtual files.
* @see #getUrls(OrderRootType)
*/
VirtualFile @NotNull [] getFiles(@NotNull OrderRootType type);
@@ -56,7 +56,7 @@ public interface OrderEntry extends Synthetic, Comparable<OrderEntry> {
* Note that list of roots is project-dependent.
*
* @param rootType the type of roots which should be returned.
* @return the list of roots of the specified type.
* @return the array of roots of the specified type.
*/
String @NotNull [] getUrls(@NotNull OrderRootType rootType);

4
platform/projectModel-api/src/com/intellij/openapi/roots/ProjectRootManager.java
View File

@@ -72,14 +72,14 @@ public abstract class ProjectRootManager extends SimpleModificationTracker {
/**
* Returns the list of content roots for all modules in the project.
*
* @return the list of content roots.
* @return the array of content roots.
*/
public abstract VirtualFile @NotNull [] getContentRoots();
/**
* Returns the list of source roots under the content roots for all modules in the project.
*
* @return the list of content source roots.
* @return the array of content source roots.
*/
public abstract VirtualFile @NotNull [] getContentSourceRoots();

2
platform/util/src/com/intellij/util/execution/ParametersListUtil.java
View File

@@ -97,7 +97,7 @@ public final class ParametersListUtil {
* </p>
*
* @param parameterString parameter string to split.
* @return array of parameters.
* @return list of parameters.
*/
@NotNull
public static List<String> parse(@NotNull String parameterString) {

2
platform/vcs-api/src/com/intellij/openapi/vcs/merge/MergeSession.java
View File

@@ -33,7 +33,7 @@ public interface MergeSession {
* Returns the list of additional columns to be displayed in the dialog. The Item type for the
* column should be VirtualFile.
*
* @return the list of columns, or an empty list if no additional columns should be displayed.
* @return the array of columns, or an empty array if no additional columns should be displayed.
*/
ColumnInfo @NotNull [] getMergeInfoColumns();

4
plugins/InspectionGadgets/src/com/siyeh/ig/errorhandling/CatchMayIgnoreExceptionInspection.java
View File

@@ -153,11 +153,11 @@ public class CatchMayIgnoreExceptionInspection extends AbstractBaseJavaLocalInsp
}
/**
* Returns true if given catch block may ignore VM exception such as NullPointerException
* Returns class name of important VM exception (like NullPointerException) if given catch block may ignore it
*
* @param parameter a catch block parameter
* @param block a catch block body
* @return true if it's determined that catch block may ignore VM exception
* @return class name of important VM exception (like NullPointerException) if given catch block may ignore it
*/
private @Nullable String mayIgnoreVMException(PsiParameter parameter, PsiCodeBlock block) {
PsiType type = parameter.getType();

2
plugins/git4idea/src/git4idea/history/GitHistoryUtils.java
View File

@@ -166,7 +166,7 @@ public final class GitHistoryUtils {
*
* @param project a {@link Project} instance for which the command is going to be invoked. Used to get Git version.
* @param hashes a list of hashes to call `git log` for
* @return a list of parameters that could be fed to a `git log` command
* @return a array of parameters that could be fed to a `git log` command
*/
public static String @NotNull [] formHashParameters(@NotNull Project project, @NotNull Collection<String> hashes) {
List<String> parameters = new ArrayList<>();

2
plugins/git4idea/src/git4idea/status/GitStagingAreaHolder.java
View File

@@ -146,7 +146,7 @@ public class GitStagingAreaHolder {
/**
* Collect dirty file paths, previous changes are included in collection.
*
* @return the set of dirty paths to check, grouped by root
* @return the map whose values are lists of dirty paths to check, grouped by root
* The paths will be automatically collapsed later if the summary length more than limit, see {@link GitHandler#isLargeCommandLine()}.
*/
@NotNull

2
python/python-psi-api/src/com/jetbrains/python/psi/PyAssignmentStatement.java
View File

@@ -35,7 +35,7 @@ public interface PyAssignmentStatement extends PyStatement, PyNamedElementContai
* Return all expressions which are considered assignment targets (to the left of the last = sign in the statement).
* Doesn't unpack tuples, parentheses or anything.
*
* @return the list of assignment target expressions
* @return the array of assignment target expressions
*/
PyExpression @NotNull [] getRawTargets();

2
xml/dom-openapi/src/com/intellij/util/xml/PropertyAccessor.java
View File

@@ -31,7 +31,7 @@ import java.lang.annotation.Target;
@Target({ElementType.METHOD})
public @interface PropertyAccessor {
/**
* @return list of property names corresponding to methods you want to replace calls to
* @return array of property names corresponding to methods you want to replace calls to
*/
String[] value();
}