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

Class BslDocumentationComment.ReturnSection

java.lang.Object

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

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

All Implemented Interfaces:

IDescriptionPart, ITypeSectionCollector

Enclosing class:

BslDocumentationComment

public static class BslDocumentationComment.ReturnSection
extends BslDocumentationComment.Section
implements ITypeSectionCollector

Class represents return section of the Bsl documentation comment. This section has description part and TypeSection. Important that description part end when TypeSection starts and cannot be continue for it.

Constructor Summary

Constructors

Constructor	Description
ReturnSection(IDescriptionPart parent, int lineNumber)	Constructor.
ReturnSection(IDescriptionPart parent, int lineNumber, int offset, int headerKeywordLenght)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addTypeSection(TypeSection typeSection)	Adds new TypeSection to type section
List<TypeSection>	getReturnTypes()	Gets TypeSection described in return section.

Methods inherited from class com._1c.g5.v8.dt.bsl.documentation.comment.BslDocumentationComment.Section

getDescription, getHeaderKeywordLength, getLineNumber, getOffset, getParent, match

Methods inherited from class java.lang.Object

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

Constructor Detail

ReturnSection

public ReturnSection(IDescriptionPart parent,
                     int lineNumber,
                     int offset,
                     int headerKeywordLenght)

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

headerKeywordLenght - the header keyword lenght

ReturnSection

public ReturnSection(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 Detail

getReturnTypes

public List<TypeSection> getReturnTypes()

Gets TypeSection described in return section. One return section can have 0..N type sections

Returns:

collection of the described TypeSections, never null

addTypeSection

public void addTypeSection(TypeSection typeSection)

Description copied from interface: ITypeSectionCollector

Adds new TypeSection to type section

Specified by:

addTypeSection in interface ITypeSectionCollector

Parameters:

typeSection - adding new TypeSection, cannot be null