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, OScriptLibraryIndex oScriptLibraryIndex, LanguageServerConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
void	addSectionIfNotEmpty(StringJoiner markupBuilder, String newContent)
String	getCallOptionsSection(MethodSymbol methodSymbol)
String	getDeprecatedSection(MethodSymbol methodSymbol)	Формирует секцию признака устаревания метода для всплывающего окна.
String	getExamplesSection(MethodSymbol methodSymbol)
String	getInferredReturnedValueNote(MethodSymbol methodSymbol, TypeSet returnTypes)	Приписка о типах, которые метод возвращает по коду, но которых нет в описании.
String	getInferredReturnedValueSection(TypeSet returnTypes)	Секция «Возвращаемое значение» по выведенным типам — для метода, у которого автор ничего не написал.
String	getLocation(MethodSymbol symbol)
String	getLocation(ModuleSymbol symbol)
String	getLocation(VariableSymbol symbol)
String	getParametersSection(MethodSymbol methodSymbol)
String	getParametersSignatureDescription(MethodSymbol methodSymbol)
String	getPurposeSection(MethodSymbol methodSymbol)
String	getReturnedValueSection(MethodSymbol methodSymbol)
String	getSignature(AnnotationSymbol symbol, MethodSymbol methodSymbol)
String	getSignature(MethodSymbol methodSymbol)
String	getSignature(VariableSymbol symbol)
String	parameterToString(ParameterDefinition parameterDefinition)
String	parameterToString(ParameterDescription parameterDescription, int level)

Methods inherited from class Object

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

Constructor Details

DescriptionFormatter

@ConstructorProperties({"resources","oScriptLibraryIndex","configuration"})
public DescriptionFormatter(Resources resources,
 OScriptLibraryIndex oScriptLibraryIndex,
 LanguageServerConfiguration configuration)

Method Details

addSectionIfNotEmpty

public void addSectionIfNotEmpty(StringJoiner markupBuilder,
 String newContent)

getDeprecatedSection

public String getDeprecatedSection(MethodSymbol methodSymbol)

Формирует секцию признака устаревания метода для всплывающего окна.

Parameters:

methodSymbol - символ метода, для которого строится секция

Returns:

markdown-блок «Устарела.» с текстом причины устаревания (если он указан в описании метода), либо пустая строка, если метод не устарел

getPurposeSection

public String getPurposeSection(MethodSymbol methodSymbol)

getParametersSection

public String getParametersSection(MethodSymbol methodSymbol)

getReturnedValueSection

public String getReturnedValueSection(MethodSymbol methodSymbol)

getInferredReturnedValueSection

public String getInferredReturnedValueSection(TypeSet returnTypes)

Секция «Возвращаемое значение» по выведенным типам — для метода, у которого автор ничего не написал.

Parameters:

returnTypes - типы возвращаемого значения.

Returns:

размеченная секция; пустая строка, если типов нет.

getInferredReturnedValueNote

public String getInferredReturnedValueNote(MethodSymbol methodSymbol,
 TypeSet returnTypes)

Приписка о типах, которые метод возвращает по коду, но которых нет в описании.

Расхождение важно видеть: описание может устареть или быть неполным, а работать код будет по тому, что возвращает на самом деле.

Parameters:

methodSymbol - метод.

returnTypes - типы возвращаемого значения.

Returns:

размеченная приписка; пустая строка, если описание ничего не упускает.

getExamplesSection

public String getExamplesSection(MethodSymbol methodSymbol)

getCallOptionsSection

public String getCallOptionsSection(MethodSymbol methodSymbol)

getLocation

public String getLocation(ModuleSymbol symbol)

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)