Package com.github._1c_syntax.bsl.languageserver.hover

Class DescriptionFormatter

java.lang.Object

com.github._1c_syntax.bsl.languageserver.hover.DescriptionFormatter

@Component
public class DescriptionFormatter
extends Object

Constructor Summary

Constructors

Constructor	Description
DescriptionFormatter(Resources resources)

Method Summary

Modifier and Type	Method	Description
void	addSectionIfNotEmpty(StringJoiner markupBuilder, String newContent)
String	getCallOptionsSection(MethodSymbol methodSymbol)
String	getExamplesSection(MethodSymbol methodSymbol)
String	getLocation(MethodSymbol symbol)
String	getLocation(VariableSymbol symbol)
String	getParametersSection(MethodSymbol methodSymbol)
String	getParametersSignatureDescription(MethodSymbol methodSymbol)
String	getPurposeSection(MethodSymbol methodSymbol)
String	getReturnedValueSection(MethodSymbol methodSymbol)
String	getSectionWithCodeFences(Collection<String> codeBlocks, String resourceKey)
String	getSignature(AnnotationSymbol symbol, MethodSymbol methodSymbol)
String	getSignature(MethodSymbol methodSymbol)
String	getSignature(VariableSymbol symbol)
String	parameterToString(ParameterDescription parameterDescription, int level)
String	parameterToString(ParameterDefinition parameterDefinition)

Methods inherited from class java.lang.Object

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

Constructor Details

DescriptionFormatter

@ConstructorProperties("resources")
public DescriptionFormatter(Resources resources)

Method Details

addSectionIfNotEmpty

public void addSectionIfNotEmpty(StringJoiner markupBuilder,
 String newContent)

getPurposeSection

public String getPurposeSection(MethodSymbol methodSymbol)

getParametersSection

public String getParametersSection(MethodSymbol methodSymbol)

getReturnedValueSection

public String getReturnedValueSection(MethodSymbol methodSymbol)

getExamplesSection

public String getExamplesSection(MethodSymbol methodSymbol)

getCallOptionsSection

public String getCallOptionsSection(MethodSymbol methodSymbol)

getSectionWithCodeFences

public String getSectionWithCodeFences(Collection<String> codeBlocks,
 String resourceKey)

getLocation

public String getLocation(MethodSymbol symbol)

getLocation

public String getLocation(VariableSymbol symbol)

getSignature

public String getSignature(MethodSymbol methodSymbol)

getSignature

public String getSignature(AnnotationSymbol symbol,
 MethodSymbol methodSymbol)

getSignature

public String getSignature(VariableSymbol symbol)

getParametersSignatureDescription

public String getParametersSignatureDescription(MethodSymbol methodSymbol)

parameterToString

public String parameterToString(ParameterDescription parameterDescription,
 int level)

parameterToString

public String parameterToString(ParameterDefinition parameterDefinition)