Package com._1c.g5.v8.dt.bsl.ui

Class BslDocumentationProvider.DocumentContent

java.lang.Object

com._1c.g5.v8.dt.bsl.ui.BslDocumentationProvider.DocumentContent

Enclosing class:

BslDocumentationProvider

public static class BslDocumentationProvider.DocumentContent
extends Object

Structured content template comment

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BslDocumentationProvider.DocumentContent.GroupTypeDescription	Contains information about group of types
static class	BslDocumentationProvider.DocumentContent.ParamContent	Contains information about parameter of method or constructor
static class	BslDocumentationProvider.DocumentContent.Reference	Contains information for html reference
static class	BslDocumentationProvider.DocumentContent.TypeContent	Contains information about Type context def

Constructor Summary

Constructors

Constructor	Description
DocumentContent(String descr, String retValDescr, List<BslDocumentationProvider.DocumentContent.GroupTypeDescription> retValType, List<BslDocumentationProvider.DocumentContent.ParamContent> paramsContent, String syntax, List<String> envs, BslDocumentationProvider.DocumentContent.TypeContent typeContent, String remark, String example, String methodicalLink)	Constructor

Method Summary

Modifier and Type	Method	Description
static String	getDocumentationFormatString(BslDocumentationProvider.DocumentContent doc)	Creates full documentation by BslDocumentationProvider.DocumentContent for object with name
static int	getHeight(String description)	Computes height in symbols for ParametersHoverInfoControl by parameter description
List<BslDocumentationProvider.DocumentContent.ParamContent>	getParamsContent()	Gets parameters content
static String	getReturnTypeStrForContentAssist(List<BslDocumentationProvider.DocumentContent.GroupTypeDescription> retValType)	Creates string description of return type name for hover in BSL
List<BslDocumentationProvider.DocumentContent.GroupTypeDescription>	getRetValType()	Gets return value type description
static String	getShortDoc(BslDocumentationProvider.DocumentContent doc)	Gets short documentation by content of BslDocumentationProvider.DocumentContent
String	getSyntax()	Gets element syntax documentation
static StringBuilder	getSyntaxWithTypes(String syntax, List<BslDocumentationProvider.DocumentContent.GroupTypeDescription> retValType, boolean isDerivedType)	Gets Full syntax name of the element with types
static String	getUnknownReturnTypeStrForContentAssist()	Gets representation of unknown type of returning value
static int	getWeight(BslDocumentationProvider.DocumentContent doc, String retvalTypes, String description)	Computes weight in symbols for ParametersHoverInfoControl by parameter description
static BslDocumentationProvider.DocumentContent	parseDocument(String content)	Parses full documentation to BslDocumentationProvider.DocumentContent

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentContent

public DocumentContent(String descr,
                       String retValDescr,
                       List<BslDocumentationProvider.DocumentContent.GroupTypeDescription> retValType,
                       List<BslDocumentationProvider.DocumentContent.ParamContent> paramsContent,
                       String syntax,
                       List<String> envs,
                       BslDocumentationProvider.DocumentContent.TypeContent typeContent,
                       String remark,
                       String example,
                       String methodicalLink)

Constructor

Parameters:

descr - description of the element, can be null

retValDescr - description of the returning value of the element, can be null

retValType - list of returning types, can be null

paramsContent - parameters of element, can be null

syntax - syntax of the element, can be null

envs - actual Environments of the element, can be null

typeContent - content of the element, if it's Type, can be null

remark - remark for element, can be null

example - example of using of the element, can be null

methodicalLink - url to methodical information, can be null

Method Detail

parseDocument

public static BslDocumentationProvider.DocumentContent parseDocument(String content)

Parses full documentation to BslDocumentationProvider.DocumentContent

Parameters:

content - full documentation, can be null

Returns:

BslDocumentationProvider.DocumentContent, can be null if content was null

getDocumentationFormatString

public static String getDocumentationFormatString(BslDocumentationProvider.DocumentContent doc)

Creates full documentation by BslDocumentationProvider.DocumentContent for object with name

Parameters:

doc - all document information, cannot be null

Returns:

full documentation, never null

getSyntaxWithTypes

public static StringBuilder getSyntaxWithTypes(String syntax,
                                               List<BslDocumentationProvider.DocumentContent.GroupTypeDescription> retValType,
                                               boolean isDerivedType)

Gets Full syntax name of the element with types

Parameters:

syntax - syntax of the element, can be null

retValType - types, can be null

Returns:

full syntax name, never null

getShortDoc

public static String getShortDoc(BslDocumentationProvider.DocumentContent doc)

Gets short documentation by content of BslDocumentationProvider.DocumentContent

Parameters:

doc - all document information, cannot be null

Returns:

short documentation, never null

getReturnTypeStrForContentAssist

public static String getReturnTypeStrForContentAssist(List<BslDocumentationProvider.DocumentContent.GroupTypeDescription> retValType)

Creates string description of return type name for hover in BSL

Parameters:

retValType - return value types description, cannot be null

Returns:

format string, never null

getUnknownReturnTypeStrForContentAssist

public static String getUnknownReturnTypeStrForContentAssist()

Gets representation of unknown type of returning value

Returns:

string "", never null

getWeight

public static int getWeight(BslDocumentationProvider.DocumentContent doc,
                            String retvalTypes,
                            String description)

Computes weight in symbols for ParametersHoverInfoControl by parameter description

Parameters:

doc - actual BslDocumentationProvider.DocumentContent for computing, can be null

retvalTypes - string presentation of return types of parameter, can be null

description - parameter text description, can be null

Returns:

weight in symbols for ParametersHoverInfoControl

getHeight

public static int getHeight(String description)

Computes height in symbols for ParametersHoverInfoControl by parameter description

Parameters:

description - parameter text description, can be null

Returns:

height in symbols for ParametersHoverInfoControl

getParamsContent

public List<BslDocumentationProvider.DocumentContent.ParamContent> getParamsContent()

Gets parameters content

Returns:

parameters content, can be null if no content for parameters

getRetValType

public List<BslDocumentationProvider.DocumentContent.GroupTypeDescription> getRetValType()

Gets return value type description

Returns:

return value type description, can be null if there is no return types

getSyntax

public String getSyntax()

Gets element syntax documentation

Returns:

element syntax documentation, can be null