Interface Describable

All Known Subinterfaces:
MethodSymbol, VariableSymbol
All Known Implementing Classes:
AbstractMethodSymbol, AbstractVariableSymbol, AnnotatedVariableSymbol, AnnotationParamSymbol, AnnotationSymbol, ConstructorSymbol, IntBasedVariableSymbol, RegularMethodSymbol, ShortBasedVariableSymbol
public interface Describable
Возможность сущности иметь описание.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<? extends SourceDefinedSymbolDescription>
    getDescription()
     
    default SymbolDescription
    getSymbolDescription()
    Унифицированное представление описания символа: подходит для hover'а, completion'а и signature-help'а, не зависит от bsl-parser'ского AST.

  • Method Details

    • getDescription

      Optional<? extends SourceDefinedSymbolDescription> getDescription()
      Returns:
      Описание символа в форме, поставляемой bsl-parser'ом (используется диагностиками, которые знают конкретные подтипы MethodDescription/VariableDescription и т.п.).

    • getSymbolDescription

      default SymbolDescription getSymbolDescription()
      Унифицированное представление описания символа: подходит для hover'а, completion'а и signature-help'а, не зависит от bsl-parser'ского AST. По умолчанию строится через ParserSymbolDescriptionAdapter поверх getDescription(), что покрывает все BSL-doc-комментарии. Сущности без parser-описания (платформенные члены, oscript-библиотеки, MD-объекты конфигурации) переопределяют этот метод напрямую.
      Returns:
      унифицированное описание или SymbolDescription.EMPTY, если описание отсутствует.