Class: Docscribe::InlineRewriter::DocBlock::Entry

Inherits:

Struct

• Object
• Struct
• Docscribe::InlineRewriter::DocBlock::Entry

Defined in:

lib/docscribe/inline_rewriter/doc_block.rb

Overview

One parsed entry inside a doc block.

‘kind` is:

• ‘:tag` for a sortable top-level tag entry

• ‘:other` for prose/separators/non-sortable content

Class Attribute Summary

• .generated ⇒ Object
• .index ⇒ Object
• .kind ⇒ Object
• .lines ⇒ Object
• .option_owner ⇒ Object
• .subject ⇒ Object
• .tag ⇒ Object

Instance Attribute Summary

• #generated ⇒ Object writeonly

  Sets the attribute generated.

• #index ⇒ Object writeonly

  Sets the attribute index.

• #kind ⇒ Object writeonly

  Sets the attribute kind.

• #lines ⇒ Object writeonly

  Sets the attribute lines.

• #option_owner ⇒ Object writeonly

  Sets the attribute option_owner.

• #subject ⇒ Object writeonly

  Sets the attribute subject.

• #tag ⇒ Object writeonly

  Sets the attribute tag.

Class Attribute Details

.generated ⇒ Object

Parameters:

• value (Object)

Returns:

• (Object)

# File 'lib/docscribe/inline_rewriter/doc_block.rb', line 47

Entry = Struct.new(
  :kind,
  :tag,
  :lines,
  :subject,
  :option_owner,
  :generated,
  :index,
  keyword_init: true
)

.index ⇒ Object

Parameters:

• value (Object)

Returns:

• (Object)

# File 'lib/docscribe/inline_rewriter/doc_block.rb', line 47

Entry = Struct.new(
  :kind,
  :tag,
  :lines,
  :subject,
  :option_owner,
  :generated,
  :index,
  keyword_init: true
)

.kind ⇒ Object

Parameters:

• value (Object)

Returns:

• (Object)

# File 'lib/docscribe/inline_rewriter/doc_block.rb', line 47

Entry = Struct.new(
  :kind,
  :tag,
  :lines,
  :subject,
  :option_owner,
  :generated,
  :index,
  keyword_init: true
)

.lines ⇒ Object

Parameters:

• value (Object)

Returns:

• (Object)

# File 'lib/docscribe/inline_rewriter/doc_block.rb', line 47

Entry = Struct.new(
  :kind,
  :tag,
  :lines,
  :subject,
  :option_owner,
  :generated,
  :index,
  keyword_init: true
)

.option_owner ⇒ Object

Parameters:

• value (Object)

Returns:

• (Object)

# File 'lib/docscribe/inline_rewriter/doc_block.rb', line 47

Entry = Struct.new(
  :kind,
  :tag,
  :lines,
  :subject,
  :option_owner,
  :generated,
  :index,
  keyword_init: true
)

.subject ⇒ Object

Parameters:

• value (Object)

Returns:

• (Object)

# File 'lib/docscribe/inline_rewriter/doc_block.rb', line 47

Entry = Struct.new(
  :kind,
  :tag,
  :lines,
  :subject,
  :option_owner,
  :generated,
  :index,
  keyword_init: true
)

.tag ⇒ Object

Parameters:

• value (Object)

Returns:

• (Object)

# File 'lib/docscribe/inline_rewriter/doc_block.rb', line 47

Entry = Struct.new(
  :kind,
  :tag,
  :lines,
  :subject,
  :option_owner,
  :generated,
  :index,
  keyword_init: true
)

Instance Attribute Details

#generated=(value) ⇒ Object

Sets the attribute generated

Parameters:

• value (Object) —

  the value to set the attribute generated to.

Returns:

• (Object) —

  the newly set value

# File 'lib/docscribe/inline_rewriter/doc_block.rb', line 47

def generated=(value)
  @generated = value
end

#index=(value) ⇒ Object

Sets the attribute index

Parameters:

• value (Object) —

  the value to set the attribute index to.

Returns:

• (Object) —

  the newly set value

# File 'lib/docscribe/inline_rewriter/doc_block.rb', line 47

def index=(value)
  @index = value
end

#kind=(value) ⇒ Object

Sets the attribute kind

Parameters:

• value (Object) —

  the value to set the attribute kind to.

Returns:

• (Object) —

  the newly set value

# File 'lib/docscribe/inline_rewriter/doc_block.rb', line 47

def kind=(value)
  @kind = value
end

#lines=(value) ⇒ Object

Sets the attribute lines

Parameters:

• value (Object) —

  the value to set the attribute lines to.

Returns:

• (Object) —

  the newly set value

# File 'lib/docscribe/inline_rewriter/doc_block.rb', line 47

def lines=(value)
  @lines = value
end

#option_owner=(value) ⇒ Object

Sets the attribute option_owner

Parameters:

• value (Object) —

  the value to set the attribute option_owner to.

Returns:

• (Object) —

  the newly set value

# File 'lib/docscribe/inline_rewriter/doc_block.rb', line 47

def option_owner=(value)
  @option_owner = value
end

#subject=(value) ⇒ Object

Sets the attribute subject

Parameters:

• value (Object) —

  the value to set the attribute subject to.

Returns:

• (Object) —

  the newly set value

# File 'lib/docscribe/inline_rewriter/doc_block.rb', line 47

def subject=(value)
  @subject = value
end

#tag=(value) ⇒ Object

Sets the attribute tag

Parameters:

• value (Object) —

  the value to set the attribute tag to.

Returns:

• (Object) —

  the newly set value

# File 'lib/docscribe/inline_rewriter/doc_block.rb', line 47

def tag=(value)
  @tag = value
end