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 andTypeSection.FieldDefinition
s 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addTypeSection(TypeSection typeSection)
Adds newTypeSection
to type sectionTypeSection.FieldDefinition
getParameterByName(String name)
GestTypeSection.FieldDefinition
by its nameList<TypeSection.FieldDefinition>
getParameterDefinitions()
GetsTypeSection.FieldDefinition
s described in parameter section.BslDocumentationComment.Description
getSourceDescription()
GetsBslDocumentationComment.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
-
-
-
-
Constructor Detail
-
ParametersSection
public ParametersSection(IDescriptionPart parent, int lineNumber, int offset, int headerKeywordLenght)
Constructor.- Parameters:
parent
- the parent object, cannot benull
.lineNumber
- number of line from the comment begining corresponding to the start line of the sectionoffset
- local line offset of the begining section on the lineheaderKeywordLenght
- 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 benull
.lineNumber
- number of line from the comment begining corresponding to the start line of the section
-
-
Method Detail
-
getSourceDescription
public BslDocumentationComment.Description getSourceDescription()
GetsBslDocumentationComment.Description
contains initial content of the parameter section. Each part of theBslDocumentationComment.Description
can beTextPart
,LinkPart
andTypeSection
.TypeSection.FieldDefinition
s will be created by this content ingetParameterDefinitions()
.- Returns:
BslDocumentationComment.Description
contains initial content of the parameter section, nevernull
-
addTypeSection
public void addTypeSection(TypeSection typeSection)
Description copied from interface:ITypeSectionCollector
Adds newTypeSection
to type section- Specified by:
addTypeSection
in interfaceITypeSectionCollector
- Parameters:
typeSection
- adding newTypeSection
, cannot benull
-
getParameterDefinitions
public List<TypeSection.FieldDefinition> getParameterDefinitions()
GetsTypeSection.FieldDefinition
s described in parameter section. Fields created by source description partgetSourceDescription()
. Each parameter method definition should be start with name of the method parameter in old comment format, or should be start fromIBslCommentToken.STAR
in new format- Returns:
- collection
TypeSection.FieldDefinition
s described in parameter section, nevernull
-
getParameterByName
public TypeSection.FieldDefinition getParameterByName(String name)
GestTypeSection.FieldDefinition
by its name- Parameters:
name
- name of the gettingTypeSection.FieldDefinition
, cannot benull
- Returns:
TypeSection.FieldDefinition
with concrete name, can benull
if there is noTypeSection.FieldDefinition
with the same name
-
-