Package com.intellij.javadoc

Class JavadocHelper.JavadocParameterInfo

java.lang.Object

com.intellij.javadoc.JavadocHelper.JavadocParameterInfo

Enclosing class:

JavadocHelper

public static class JavadocHelper.JavadocParameterInfo
extends java.lang.Object

Encapsulates information about source code line that holds javadoc parameter.

Field Summary

Fields

Modifier and Type	Field and Description
int	lastLine Last logical line occupied by the current javadoc parameter.
LogicalPosition	parameterDescriptionStartPosition
LogicalPosition	parameterNameEndPosition Logical position that points to location just after javadoc parameter name.

Constructor Summary

Constructors

Constructor and Description
JavadocParameterInfo(LogicalPosition parameterNameEndPosition, LogicalPosition parameterDescriptionStartPosition, int lastLine)

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

parameterNameEndPosition

public final LogicalPosition parameterNameEndPosition

Logical position that points to location just after javadoc parameter name.

Example:

   /**
    * @param i[X]  description
    */
 

parameterDescriptionStartPosition

public final LogicalPosition parameterDescriptionStartPosition

lastLine

public final int lastLine

Last logical line occupied by the current javadoc parameter.

Constructor Detail

JavadocParameterInfo

public JavadocParameterInfo(LogicalPosition parameterNameEndPosition,
                            LogicalPosition parameterDescriptionStartPosition,
                            int lastLine)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object