Class: Docscribe::Plugin::Tag

Inherits:

Struct

• Object
• Struct
• Docscribe::Plugin::Tag

Defined in:

lib/docscribe/plugin/tag.rb

Overview

A single YARD-style tag returned by a TagPlugin.

Examples:

Simple tag

Tag.new(name: 'since', text: '1.3.0')
# => # @since 1.3.0

Tag with types

Tag.new(name: 'raise', types: ['ArgumentError'], text: 'if name is nil')
# => # @raise [ArgumentError] if name is nil

Instance Attribute Summary

• #name ⇒ String

  Tag name without leading @.

• #text ⇒ String^?

  Text after the type bracket.

• #types ⇒ Array<String>^?

  Optional type list rendered as [Foo, Bar].

Instance Attribute Details

#name ⇒ String

Returns tag name without leading @.

Returns:

• (String) —

  tag name without leading @

# File 'lib/docscribe/plugin/tag.rb', line 21

Tag = Struct.new(:name, :text, :types, keyword_init: true)

#text ⇒ String^?

Returns text after the type bracket.

Returns:

• (String, nil) —

  text after the type bracket

# File 'lib/docscribe/plugin/tag.rb', line 21

Tag = Struct.new(:name, :text, :types, keyword_init: true)

#types ⇒ Array<String>^?

Returns optional type list rendered as [Foo, Bar].

Returns:

• (Array<String>, nil) —

  optional type list rendered as [Foo, Bar]

# File 'lib/docscribe/plugin/tag.rb', line 21

Tag = Struct.new(:name, :text, :types, keyword_init: true)