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 IDescriptionPartCommon 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 SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description intgetLineNumber()Gets the line nubmer corresponding to part.intgetOffset()Gets offset of the begining part.IDescriptionPartgetParent()Gets the parent object.booleanmatch(int lineNumber, int offset)Checks that this description part corresponding to the concrete line number and offset
 
- 
- 
- 
Method Detail- 
getParentIDescriptionPart getParent() Gets the parent object.- Returns:
- the parent object, can return nullif it is root objectBslDocumentationCommentor object created separetly form parsing source code.
 
 - 
getOffsetint getOffset() Gets offset of the begining part. Offset - local inline offset- Returns:
- offset of the begining part.
 
 - 
getLineNumberint 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
 
 - 
matchboolean 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 line
- offset- local offset on the comment line
- Returns:
- trueif this description part corresponding to the send line number and offset,- falseotherwise
 
 
- 
 
-