module Yoda
  module Model
    module Descriptions
      # @abstract
      class Base
        # @abstract
        # @return [String]
        def title
          fail NotImplementedError
        end

        # @abstract
        # @return [String]
        def sort_text
          fail NotImplementedError
        end

        # @return [String]
        def label
          sort_text
        end

        # @abstract
        # @return [String]
        def to_markdown
          fail NotImplementedError
        end

        # Return an LSP MarkedString content for description
        # @return [String, Hash]
        def markup_content
          to_markdown
        end
      end
    end
  end
end