org.eclipse.xtext.documentation.impl

Class MultiLineJavaDocTypeReferenceProvider

java.lang.Object

org.eclipse.xtext.documentation.impl.MultiLineJavaDocTypeReferenceProvider

All Implemented Interfaces:

IJavaDocTypeReferenceProvider

public class MultiLineJavaDocTypeReferenceProvider
extends Object
implements IJavaDocTypeReferenceProvider

Since:

2.4

Author:

Holger Schill - Initial contribution and API, Jan Koehnlein

Field Summary

Fields

Modifier and Type	Field and Description
protected String	lineDelimiter Deprecated.

Fields inherited from interface org.eclipse.xtext.documentation.IJavaDocTypeReferenceProvider

LINK_TAG, LINK_TAG_WITH_SUFFIX, SEE_TAG, SEE_TAG_WITH_SUFFIX

Constructor Summary

Constructors

Constructor and Description
MultiLineJavaDocTypeReferenceProvider()

Method Summary

Methods

Modifier and Type	Method and Description
List<ReplaceRegion>	computeParameterTypeRefRegions(INode node)
protected void	computeRegions(List<ReplaceRegion> regions, Iterable<ILeafNode> leafNodes, String toSearch, String... ends) Computes regions between a given string to search and different ends searched by their precedence
protected void	computeRegions(List<ReplaceRegion> regions, Iterable<ILeafNode> leafNodes, String toSearch, String end, String optionalEnd, String optionalEnd2) Deprecated. use computeRegions(List, Iterable, String, String...)
List<ReplaceRegion>	computeTypeRefRegions(INode node)

Methods inherited from class java.lang.Object

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

Field Detail

lineDelimiter

@Deprecated
protected String lineDelimiter

Deprecated.

Constructor Detail

MultiLineJavaDocTypeReferenceProvider

public MultiLineJavaDocTypeReferenceProvider()

Method Detail

computeTypeRefRegions

public List<ReplaceRegion> computeTypeRefRegions(INode node)

Specified by:

computeTypeRefRegions in interface IJavaDocTypeReferenceProvider

computeParameterTypeRefRegions

public List<ReplaceRegion> computeParameterTypeRefRegions(INode node)

Specified by:

computeParameterTypeRefRegions in interface IJavaDocTypeReferenceProvider

computeRegions

@Deprecated
protected void computeRegions(List<ReplaceRegion> regions,
                             Iterable<ILeafNode> leafNodes,
                             String toSearch,
                             String end,
                             String optionalEnd,
                             String optionalEnd2)

Deprecated. use computeRegions(List, Iterable, String, String...)

Computes regions between a given string to search and different ends searched by their precedence

Parameters:

regions - - List to put new regions in

leafNodes - - nodes to search in

toSearch - - String to search

end - - end with highest precedence

optionalEnd - - end with lower precedence

optionalEnd2 - - end with lowest precedence

computeRegions

protected void computeRegions(List<ReplaceRegion> regions,
                  Iterable<ILeafNode> leafNodes,
                  String toSearch,
                  String... ends)

Computes regions between a given string to search and different ends searched by their precedence

Parameters:

regions - - List to put new regions in

leafNodes - - nodes to search in

toSearch - - String to search

ends - - ends in decreasing precedence

Since:

2.6