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

Direct Known Subclasses:

BslDocumentationComment.ParametersSection, BslDocumentationComment.ReturnSection, TypeSection

Enclosing class:

BslDocumentationComment

public static class BslDocumentationComment.Section
extends Object

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(int lineNumber)	Constructor.
Section(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

Methods inherited from class java.lang.Object

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

Constructor Detail

Section

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

Constructor

Parameters:

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(int lineNumber)

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

Parameters:

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

Method Detail

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

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

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