Package com.intellij.javadoc

Class JavadocNavigationDelegate

java.lang.Object

com.intellij.openapi.editor.EditorNavigationDelegateAdapter

com.intellij.javadoc.JavadocNavigationDelegate

All Implemented Interfaces:

EditorNavigationDelegate

public class JavadocNavigationDelegate
extends EditorNavigationDelegateAdapter

Holds javadoc-specific navigation logic.

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.editor.EditorNavigationDelegate

EditorNavigationDelegate.Result

Field Summary

Fields inherited from interface com.intellij.openapi.editor.EditorNavigationDelegate

EP_NAME

Constructor Summary

Constructors

Constructor and Description
JavadocNavigationDelegate()

Method Summary

Modifier and Type	Method and Description
EditorNavigationDelegate.Result	navigateToLineEnd(Editor editor, DataContext dataContext) Improves navigation in case of incomplete javadoc parameter descriptions.
static EditorNavigationDelegate.Result	navigateToLineEnd(Editor editor, PsiFile psiFile)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavadocNavigationDelegate

public JavadocNavigationDelegate()

Method Detail

navigateToLineEnd

public EditorNavigationDelegate.Result navigateToLineEnd(Editor editor,
                                                         DataContext dataContext)

Improves navigation in case of incomplete javadoc parameter descriptions.

Example:

   /**
    * @param i[caret]
    * @param secondArgument
    */
    abstract void test(int i, int secondArgument);
 

We expect the caret to be placed in position of parameter description start then (code style is condifured to align parameter descriptions):

   /**
    * @param i                 [caret]
    * @param secondArgument
    */
    abstract void test(int i, int secondArgument);
 

or this one for non-aligned descriptions:

   /**
    * @param i    [caret]
    * @param secondArgument
    */
    abstract void test(int i, int secondArgument);
 

Specified by:

navigateToLineEnd in interface EditorNavigationDelegate

Overrides:

navigateToLineEnd in class EditorNavigationDelegateAdapter

Parameters:

editor - current editor

Returns:

processing result

navigateToLineEnd

public static EditorNavigationDelegate.Result navigateToLineEnd(Editor editor,
                                                                PsiFile psiFile)