Package com.github._1c_syntax.bsl.languageserver.context.symbol.description

Class DescriptionReader

java.lang.Object
com.github._1c_syntax.bsl.languageserver.context.symbol.description.DescriptionReader
public final class DescriptionReader extends Object
Вспомогательный класс для чтения данных из описания метода

  • Method Details

    • readParameters

      public static List<ParameterDescription> readParameters(BSLMethodDescriptionParser.MethodDescriptionContext ctx)
      Выполняет разбор прочитанного AST дерева описания метода и формирует список описаний параметров метода
      Parameters:
      ctx - Дерево описания метода
      Returns:
      Список описаний параметров метода

    • readReturnedValue

      public static List<TypeDescription> readReturnedValue(BSLMethodDescriptionParser.MethodDescriptionContext ctx)
      Выполняет разбор прочитанного AST дерева описания метода и формирует список описаний возвращаемых значений
      Parameters:
      ctx - Дерево описания метода
      Returns:
      Список описаний возвращаемых значений

    • readDeprecationInfo

      public static String readDeprecationInfo(BSLMethodDescriptionParser.MethodDescriptionContext ctx)
      Выполняет разбор прочитанного AST дерева описания метода и возвращает описание устаревшего метода
      Parameters:
      ctx - Дерево описания метода
      Returns:
      Описание устаревшего метода

    • readCallOptions

      public static List<String> readCallOptions(BSLMethodDescriptionParser.MethodDescriptionContext ctx)
      Выполняет разбор прочитанного AST дерева описания метода и возвращает список вариантов вызова
      Parameters:
      ctx - Дерево описания метода
      Returns:
      Список вариантов вызова

    • readExamples

      public static List<String> readExamples(BSLMethodDescriptionParser.MethodDescriptionContext ctx)
      Выполняет разбор прочитанного AST дерева описания метода и возвращает список примеров
      Parameters:
      ctx - Дерево описания метода
      Returns:
      Список примеров

    • readPurposeDescription

      public static String readPurposeDescription(BSLMethodDescriptionParser.MethodDescriptionContext ctx)
      Выполняет разбор прочитанного AST дерева описания метода и возвращает описание назначения метода.
      Parameters:
      ctx - Дерево описания метода
      Returns:
      Описание назначения метода

    • readLink

      public static String readLink(BSLMethodDescriptionParser.MethodDescriptionContext ctx)
      Выполняет разбор прочитанного AST дерева описания метода и достает описание назначения метода. Если описание метода представляет собой только ссылку, то возвращает ее значение, иначе - пустая строка
      Parameters:
      ctx - Дерево описания метода
      Returns:
      Ссылка в методе