Class: Docks::Tags::Base

Inherits:

Object

• Object
• Docks::Tags::Base

Includes:

Processors, Singleton

Defined in:

lib/docks/tags/base_tag.rb

Overview

Public: The base tag from which bundled and custom tags can inherit.

Direct Known Subclasses

Access, ActivateWith, Active, Alias, Author, Beta, Compatibility, DemoType, Deprecated, Description, Example, Factory, For, Group, Helper, IncludeWith, IncludedSymbol, JavascriptAction, Klass, Link, Markup, Member, Name, Object, Param, Pattern, Preclude, Private, Public, Require, Returns, SetBy, Signature, Since, Source, Static, Subcomponent, Subtitle, SymbolType, Throws, Title, Type, UsedBy, Value, Variation

Constant Summary

Constants included from Processors

Processors::CODE_BLOCK_INDICATOR, Processors::HEADING_INDICATOR, Processors::HEADING_UNDERLINE_INDICATOR, Processors::LIST_ITEM_INDICATOR

Instance Attribute Summary

• #name ⇒ Object readonly

  Returns the value of attribute name.

Instance Method Summary

• #multiline? ⇒ Boolean
• #multiple_allowed? ⇒ Boolean
• #parseable? ⇒ Boolean
• #process(symbol) ⇒ Object
• #setup_post_processors ⇒ Object
• #synonyms ⇒ Object
• #type ⇒ Object

Methods included from Processors

#code_block_with_language_and_description, #ensure_valid_demo_type, #join_with_smart_line_breaks, #multiline_description, #name_and_parenthetical, #parenthetical_options, #split_on_characters, #split_on_commas_spaces_and_pipes, #split_on_top_level_parens_commas_and_pipes, #split_types, #stringy_boolean

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.

# File 'lib/docks/tags/base_tag.rb', line 12

def name
  @name
end

Instance Method Details

#multiline? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/docks/tags/base_tag.rb', line 14

def multiline?
  @multiline = true if @multiline.nil?
  @multiline
end

#multiple_allowed? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/docks/tags/base_tag.rb', line 19

def multiple_allowed?
  @multiple_allowed = false if @multiple_allowed.nil?
  @multiple_allowed
end

#parseable? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/docks/tags/base_tag.rb', line 28

def parseable?
  @parseable = true if @parseable.nil?
  @parseable
end

#process(symbol) ⇒ Object

# File 'lib/docks/tags/base_tag.rb', line 37

def process(symbol); symbol end

#setup_post_processors ⇒ Object

# File 'lib/docks/tags/base_tag.rb', line 39

def setup_post_processors; end

#synonyms ⇒ Object

# File 'lib/docks/tags/base_tag.rb', line 33

def synonyms
  @synonyms ||= []
end

#type ⇒ Object

# File 'lib/docks/tags/base_tag.rb', line 24

def type
  @type ||= Docks::Types::Tags::ONE_PER_BLOCK
end