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

Class BslDocumentationComment.ParametersSection

java.lang.Object

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

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

All Implemented Interfaces:

IDescriptionPart, ITypeSectionCollector

Enclosing class:

BslDocumentationComment

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

Class represents parameter section of the Bsl documentation comment. This section has description part and TypeSection.FieldDefinitions corresponding to the method parameters. Important that description part end when the first parameter was described.

Constructor Summary

Constructors

Constructor	Description
ParametersSection(IDescriptionPart parent, int lineNumber)	Constructor.
ParametersSection(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
TypeSection.FieldDefinition	getParameterByName(String name)	Gest TypeSection.FieldDefinition by its name
List<TypeSection.FieldDefinition>	getParameterDefinitions()	Gets TypeSection.FieldDefinitions described in parameter section.
BslDocumentationComment.Description	getSourceDescription()	Gets BslDocumentationComment.Description contains initial content of the parameter 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

ParametersSection

public ParametersSection(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 - length of the keyword of the section

ParametersSection

public ParametersSection(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

getSourceDescription

public BslDocumentationComment.Description getSourceDescription()

Gets BslDocumentationComment.Description contains initial content of the parameter section. Each part of the BslDocumentationComment.Description can be TextPart, LinkPart and TypeSection. TypeSection.FieldDefinitions will be created by this content in getParameterDefinitions().

Returns:

BslDocumentationComment.Description contains initial content of the parameter section, 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

getParameterDefinitions

public List<TypeSection.FieldDefinition> getParameterDefinitions()

Gets TypeSection.FieldDefinitions described in parameter section. Fields created by source description part getSourceDescription(). Each parameter method definition should be start with name of the method parameter in old comment format, or should be start from IBslCommentToken.STAR in new format

Returns:

collection TypeSection.FieldDefinitions described in parameter section, never null

getParameterByName

public TypeSection.FieldDefinition getParameterByName(String name)

Gest TypeSection.FieldDefinition by its name

Parameters:

name - name of the getting TypeSection.FieldDefinition, cannot be null

Returns:

TypeSection.FieldDefinition with concrete name, can be null if there is no TypeSection.FieldDefinition with the same name