Class: Yoda::Model::Descriptions::Base Abstract

Inherits:

Object

• Object
• Yoda::Model::Descriptions::Base

Defined in:

lib/yoda/model/descriptions/base.rb

Overview

This class is abstract.

Direct Known Subclasses

CommentTokenDescription, FunctionDescription, NodeDescription, ValueDescription, VariableDescription, WordDescription

Instance Method Summary

• #label ⇒ String
• #markup_content ⇒ String, Hash

  Return an LSP MarkedString content for description.

• #sort_text ⇒ String abstract
• #title ⇒ String abstract
• #to_markdown ⇒ String abstract

Instance Method Details

#label ⇒ String

Returns:

• (String)

# File 'lib/yoda/model/descriptions/base.rb', line 19

def label
  sort_text
end

#markup_content ⇒ String, Hash

Return an LSP MarkedString content for description

Returns:

• (String, Hash)

# File 'lib/yoda/model/descriptions/base.rb', line 31

def markup_content
  to_markdown
end

#sort_text ⇒ String

This method is abstract.

Returns:

• (String)

# File 'lib/yoda/model/descriptions/base.rb', line 14

def sort_text
  fail NotImplementedError
end

#title ⇒ String

This method is abstract.

Returns:

• (String)

# File 'lib/yoda/model/descriptions/base.rb', line 8

def title
  fail NotImplementedError
end

#to_markdown ⇒ String

This method is abstract.

Returns:

• (String)

# File 'lib/yoda/model/descriptions/base.rb', line 25

def to_markdown
  fail NotImplementedError
end