BreadcrumbsProvider: javadoc cleanup
authorPatrick Scheibe <patrick.scheibe@jetbrains.com>
Tue, 24 May 2022 03:44:49 +0000 (05:44 +0200)
committerintellij-monorepo-bot <intellij-monorepo-bot-no-reply@jetbrains.com>
Tue, 24 May 2022 03:58:50 +0000 (03:58 +0000)
GitOrigin-RevId: 4080c4ef956527b2379ac882f8e202241458b1dc

platform/editor-ui-api/src/com/intellij/ui/breadcrumbs/BreadcrumbsProvider.java

index 92f23b1f0acb9f1e5eaf582522d76a5731233559..85f4cdd1d365f3b0181a7f43ff28e713fe2c4da3 100644 (file)
@@ -14,33 +14,34 @@ import java.util.List;
 import static java.util.Collections.emptyList;
 
 /**
- * Allows to provide a language-specific breadcrumbs,
- * i.e. path to the file root from a selected PSI element.
+ * Allows providing language-specific breadcrumbs, i.e. path to the file root from a selected PSI element.
  */
 public interface BreadcrumbsProvider {
   ExtensionPointName<BreadcrumbsProvider> EP_NAME = ExtensionPointName.create("com.intellij.breadcrumbsInfoProvider");
 
   /**
-   * @return an array of languages supported by this provider
+   * @return array of languages supported by this provider
    */
   Language[] getLanguages();
 
   /**
    * @param element that represents a single crumb
-   * @return {@code true} if the specified element is supported by this provider
+   * @return {@code true} if this provider supports the specified element
    */
   boolean acceptElement(@NotNull PsiElement element);
 
   /**
+   * Determines the text for a single crumb from the provided element.
+   *
    * @param element that represents a single crumb
-   * @return a text for the specified element
+   * @return text for the crumb
    */
   @NotNull
   @NlsSafe String getElementInfo(@NotNull PsiElement element);
 
   /**
    * @param element that represents a single crumb
-   * @return an icon for the specified element
+   * @return icon for the crumb
    */
   @Nullable
   default Icon getElementIcon(@NotNull PsiElement element) {
@@ -49,7 +50,7 @@ public interface BreadcrumbsProvider {
 
   /**
    * @param element that represents a single crumb
-   * @return a description for the specified element
+   * @return description for the crumb
    */
   @Nullable
   default @NlsSafe String getElementTooltip(@NotNull PsiElement element) {
@@ -58,7 +59,7 @@ public interface BreadcrumbsProvider {
 
   /**
    * @param element that represents a single crumb
-   * @return an element that represents a parent crumb, or {@code null}
+   * @return element that represents a parent crumb, or {@code null}
    */
   @Nullable
   default PsiElement getParent(@NotNull PsiElement element) {
@@ -69,7 +70,7 @@ public interface BreadcrumbsProvider {
    * Reserved for future releases. Not supported yet.
    *
    * @param element that represents a single crumb
-   * @return list of elements to navigate
+   * @return list of elements to navigate
    */
   @NotNull
   default List<PsiElement> getChildren(@NotNull PsiElement element) {
@@ -78,7 +79,7 @@ public interface BreadcrumbsProvider {
 
   /**
    * @param element that represents a single crumb
-   * @return a list of actions for context menu
+   * @return list of actions for the context menu
    */
   @NotNull
   default List<? extends Action> getContextActions(@NotNull PsiElement element) {