Interface SymbolDescription

All Known Implementing Classes:
ParserSymbolDescriptionAdapter
public interface SymbolDescription
Текстовое описание сущности (символа, члена типа, типа в целом, параметра) для отображения в hover/completion/signature-help.

Сознательно не привязан к bsl-parser — реализации могут поставлять описание из самых разных источников:

  • BSL-doc-comment над SourceDefinedSymbol'ом (через ParserSymbolDescriptionAdapter);
  • JSON-метаданные платформенных типов;
  • lib.config.json OneScript-библиотек;
  • аналитика Configuration.xml (например, синонимы).

Параметры/возвращаемые значения методов остаются на стороне SignatureDescriptor/ParameterDescriptor — здесь только общая описательная часть, релевантная любому символу.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final SymbolDescription
    EMPTY
    Пустое описание — neutral element для интерфейса.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDeprecationInfo()
     
    String
    getPurposeDescription()
     
    boolean
    isDeprecated()
     
    default boolean
    isEmpty()
     
    static SymbolDescription
    of(String description)
    Простой фабричный метод для описания «только текст».
    static SymbolDescription
    of(String description, boolean deprecated, String deprecationInfo)
    Фабричный метод для описания с пометкой об устаревании.

  • Field Details

    • EMPTY

      static final SymbolDescription EMPTY
      Пустое описание — neutral element для интерфейса.

  • Method Details

    • getPurposeDescription

      String getPurposeDescription()
      Returns:
      основной текст описания (без блока deprecation, без параметров). Никогда не null; пустая строка означает «описания нет».

    • isDeprecated

      boolean isDeprecated()
      Returns:
      true, если сущность помечена как устаревшая.

    • getDeprecationInfo

      String getDeprecationInfo()
      Returns:
      сопровождающий текст об устаревании (например, на что заменено). Никогда не null; пустая строка допустима.

    • isEmpty

      default boolean isEmpty()
      Returns:
      true если описание считается «пустым» — нет ни описания, ни пометки об устаревании. Используется для условного формирования блоков hover.

    • of

      static SymbolDescription of(String description)
      Простой фабричный метод для описания «только текст».

    • of

      static SymbolDescription of(String description, boolean deprecated, String deprecationInfo)
      Фабричный метод для описания с пометкой об устаревании.