From 8028c625d022fcfbaffe03cecd725f8db6cc6c0f Mon Sep 17 00:00:00 2001 From: Sergey Malenkov Date: Tue, 6 Mar 2018 16:29:19 +0300 Subject: [PATCH] IDEA-186349 update javadoc after review --- .../core-api/src/com/intellij/pom/Navigatable.java | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/platform/core-api/src/com/intellij/pom/Navigatable.java b/platform/core-api/src/com/intellij/pom/Navigatable.java index 26181ab138a9..a617a07c539d 100644 --- a/platform/core-api/src/com/intellij/pom/Navigatable.java +++ b/platform/core-api/src/com/intellij/pom/Navigatable.java @@ -17,6 +17,13 @@ public interface Navigatable { void navigate(boolean requestFocus); /** + * Indicates whether this instance supports navigation of any kind. + * Usually this method is called to ensure that navigation is possible. + * Note that it is not called if navigation to source is supported, + * i.e. {@link #canNavigateToSource()} returns {@code true}. + * We assume that this method should return {@code true} in such case, + * so implement this method respectively. + * * @return {@code false} if navigation is not possible for any reason. */ boolean canNavigate(); @@ -24,10 +31,10 @@ public interface Navigatable { /** * Indicates whether this instance supports navigation to source (that means some kind of editor). * Note that navigation can be supported even if this method returns {@code false}. - * In such cases it is not recommended to do batch navigation - * for all navigatables available via {@link CommonDataKeys#NAVIGATABLE_ARRAY}, + * In such cases it is not recommended to do batch navigation for all navigatables + * available via {@link com.intellij.openapi.actionSystem.CommonDataKeys#NAVIGATABLE_ARRAY}, * because it may lead to opening several modal dialogs. - * Use {@link OpenSourceUtil#navigate} to process such arrays correctly. + * Use {@link com.intellij.util.OpenSourceUtil#navigate} to process such arrays correctly. * * @return {@code false} if navigation to source is not possible for any reason. */