Interface IDescriptionPart
-
- All Known Implementing Classes:
BslDocumentationComment
,BslDocumentationComment.Description
,BslDocumentationComment.ParametersSection
,BslDocumentationComment.ReturnSection
,BslDocumentationComment.Section
,DescriptionPart
,LinkPart
,TextPart
,TypeSection
,TypeSection.FieldDefinition
,TypeSection.LinkContainsTypeDefinition
,TypeSection.TypeDefinition
public interface IDescriptionPart
Common interface for describing information in Bsl documentation comments. Commonly extract next type of information:- text description of comment parts
- link to the configuration objects and exported methods
- description of the types and extra fields of the type
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getLineNumber()
Gets the line nubmer corresponding to part.int
getOffset()
Gets offset of the begining part.IDescriptionPart
getParent()
Gets the parent object.boolean
match(int lineNumber, int offset)
Checks that this description part corresponding to the concrete line number and offset
-
-
-
Method Detail
-
getParent
IDescriptionPart getParent()
Gets the parent object.- Returns:
- the parent object, can return
null
if it is root objectBslDocumentationComment
or object created separetly form parsing source code.
-
getOffset
int getOffset()
Gets offset of the begining part. Offset - local inline offset- Returns:
- offset of the begining part.
-
getLineNumber
int getLineNumber()
Gets the line nubmer corresponding to part. Numeration starts from 0 Line number - line number corresponding to the begining of the documentation comment. Each comment starts with line with number 0- Returns:
- the line nubmer corresponding to part
-
match
boolean match(int lineNumber, int offset)
Checks that this description part corresponding to the concrete line number and offset- Parameters:
lineNumber
- number of the documentation comment lineoffset
- local offset on the comment line- Returns:
true
if this description part corresponding to the send line number and offset,false
otherwise
-
-