IJavaDocTypeReferenceProvider (org.eclipse.xtext 2.30.0 API)

All Known Implementing Classes:

MultiLineJavaDocTypeReferenceProvider
```
public interface IJavaDocTypeReferenceProvider
```
Since:

2.4

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`LINK_TAG`
`static java.lang.String`	`LINK_TAG_WITH_SUFFIX`
`static java.lang.String`	`SEE_TAG`
`static java.lang.String`	`SEE_TAG_WITH_SUFFIX`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default EObjectInComment`	`computeEObjectReferencedInComment(XtextResource resource, int offset)`	Returns the referenced element in javadoc comment at a given offset.
`java.util.List<org.eclipse.xtext.util.ReplaceRegion>`	`computeParameterTypeRefRegions(INode commentNode)`
`java.util.List<org.eclipse.xtext.util.ReplaceRegion>`	`computeTypeRefRegions(INode commentNode)`

Field Detail
- SEE_TAG
```
static final java.lang.String SEE_TAG
```
  See Also:
  
  Constant Field Values
- SEE_TAG_WITH_SUFFIX
```
static final java.lang.String SEE_TAG_WITH_SUFFIX
```
  See Also:
  
  Constant Field Values
- LINK_TAG
```
static final java.lang.String LINK_TAG
```
  See Also:
  
  Constant Field Values
- LINK_TAG_WITH_SUFFIX
```
static final java.lang.String LINK_TAG_WITH_SUFFIX
```
  See Also:
  
  Constant Field Values

Method Detail

computeTypeRefRegions

java.util.List<org.eclipse.xtext.util.ReplaceRegion> computeTypeRefRegions(INode commentNode)

computeParameterTypeRefRegions

java.util.List<org.eclipse.xtext.util.ReplaceRegion> computeParameterTypeRefRegions(INode commentNode)

computeEObjectReferencedInComment
```
default EObjectInComment computeEObjectReferencedInComment(XtextResource resource,
                                                           int offset)
```
Returns the referenced element in javadoc comment at a given offset. Returns null in case no element is referenced at the given offset.

Since:

2.16