Package com.intellij.javadoc

Class JavadocHelper

java.lang.Object

com.intellij.javadoc.JavadocHelper

public class JavadocHelper
extends java.lang.Object

This class is not singleton but provides single-point-of-usage field.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavadocHelper.JavadocParameterInfo Encapsulates information about source code line that holds javadoc parameter.

Constructor Summary

Constructors

Constructor and Description
JavadocHelper()

Method Summary

Modifier and Type	Method and Description
LogicalPosition	calculateDescriptionStartPosition(PsiFile psiFile, java.util.Collection<? extends JavadocHelper.JavadocParameterInfo> data, JavadocHelper.JavadocParameterInfo anchor) Calculates desired position of target javadoc parameter's description start.
static JavadocHelper	getInstance()
void	navigate(LogicalPosition position, Editor editor, Project project) Tries to navigate caret at the given editor to the target position inserting missing white spaces if necessary.
Pair<JavadocHelper.JavadocParameterInfo,java.util.List<JavadocHelper.JavadocParameterInfo>>	parse(PsiFile psiFile, Editor editor, int offset) Returns information about all lines that contain javadoc parameters and are adjacent to the one that holds given offset.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocHelper

public JavadocHelper()

Method Detail

getInstance

public static JavadocHelper getInstance()

navigate

public void navigate(LogicalPosition position,
                     Editor editor,
                     Project project)

Tries to navigate caret at the given editor to the target position inserting missing white spaces if necessary.

Parameters:

position - target caret position

editor - target editor

project - target project

calculateDescriptionStartPosition

public LogicalPosition calculateDescriptionStartPosition(PsiFile psiFile,
                                                         java.util.Collection<? extends JavadocHelper.JavadocParameterInfo> data,
                                                         JavadocHelper.JavadocParameterInfo anchor)

Calculates desired position of target javadoc parameter's description start.

Parameters:

psiFile - PSI holder

data - parsed adjacent javadoc parameters

anchor - descriptor for the target parameter

Returns:

logical position that points to the desired parameter description start location

parse

public Pair<JavadocHelper.JavadocParameterInfo,java.util.List<JavadocHelper.JavadocParameterInfo>> parse(PsiFile psiFile,
                                                                                                         Editor editor,
                                                                                                         int offset)

Returns information about all lines that contain javadoc parameters and are adjacent to the one that holds given offset.

Parameters:

psiFile - PSI holder for the document exposed the given editor

editor - target editor

offset - target offset that identifies anchor line to check

Returns:

pair like (javadoc info for the line identified by the given offset; list of javadoc parameter infos for adjacent lines if any