Package com._1c.g5.v8.dt.bsl.documentation.comment

Class BslDocumentationComment.Section

java.lang.Object

com._1c.g5.v8.dt.bsl.documentation.comment.BslDocumentationComment.Section

All Implemented Interfaces:

IDescriptionPart

Direct Known Subclasses:

BslDocumentationComment.ParametersSection, BslDocumentationComment.ReturnSection, TypeSection

Enclosing class:

BslDocumentationComment

public static class BslDocumentationComment.Section
extends Object
implements IDescriptionPart

Class represents section of the Bsl documentation comment. There are next section:

• parameter section
• call option section
• return section
• example section

Each section start with special keyword. See IBslCommentToken

Constructor Summary

Constructors

Constructor	Description
Section(IDescriptionPart parent, int lineNumber)	Constructor.
Section(IDescriptionPart parent, int lineNumber, int offset, int headerKeywordLength)	Constructor.

Method Summary

Modifier and Type	Method	Description
BslDocumentationComment.Description	getDescription()	Gets BslDocumentationComment.Description of the section
int	getHeaderKeywordLength()	Gets length of the keyword of the section
int	getLineNumber()	Gets number of line from the comment begining corresponding to the start line of the section
int	getOffset()	Gets local line offset of the begining section on the line
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

Methods inherited from class java.lang.Object

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

Constructor Details

Section

public Section(IDescriptionPart parent,
 int lineNumber,
 int offset,
 int headerKeywordLength)

Constructor.

Parameters:

parent - the parent object, cannot be null.

lineNumber - number of line from the comment begining corresponding to the start line of the section

offset - local line offset of the begining section on the line

headerKeywordLength - length of the keyword of the section

Section

public Section(IDescriptionPart parent,
 int lineNumber)

Constructor. This constructor should be used if section description created programmatically

Parameters:

parent - the parent object, cannot be null.

lineNumber - number of line from the comment begining corresponding to the start line of the section

Method Details

getParent

public IDescriptionPart getParent()

Gets the parent object.

Specified by:

getParent in interface IDescriptionPart

Returns:

the parent object, can return null if it is created separetly form parsing

getDescription

public BslDocumentationComment.Description getDescription()

Gets BslDocumentationComment.Description of the section

Returns:

BslDocumentationComment.Description of the section, never null

getLineNumber

public int getLineNumber()

Gets number of line from the comment begining corresponding to the start line of the section

Specified by:

getLineNumber in interface IDescriptionPart

Returns:

number of line from the comment begining corresponding to the start line of the section

getOffset

public int getOffset()

Gets local line offset of the begining section on the line

Specified by:

getOffset in interface IDescriptionPart

Returns:

local line offset of the begining section on the line, offset can be -1 if offset wasnot set

getHeaderKeywordLength

public int getHeaderKeywordLength()

Gets length of the keyword of the section

Returns:

llength of the keyword of the section, length can be -1 if length wasnot set

match

public boolean match(int lineNumber,
 int offset)

Description copied from interface: IDescriptionPart

Checks that this description part corresponding to the concrete line number and offset

Specified by:

match in interface IDescriptionPart

Parameters:

lineNumber - number of the documentation comment line

offset - local offset on the comment line

Returns:

true if this description part corresponding to the send line number and offset, false otherwise