Class: Docscribe::Plugin::Base::TagPlugin

Inherits:

Object

• Object
• Docscribe::Plugin::Base::TagPlugin

Defined in:

lib/docscribe/plugin/base/tag_plugin.rb

Overview

Base class for tag plugins.

TagPlugins hook into already-collected method insertions and append additional YARD tags to the generated doc block.

Examples:

class SincePlugin < Docscribe::Plugin::Base::TagPlugin
  def initialize(version:)
    @version = version
  end

  def call(context)
    [Docscribe::Plugin::Tag.new(name: 'since', text: @version)]
  end
end

Docscribe::Plugin::Registry.register(SincePlugin.new(version: '1.3.0'))

Instance Method Summary

• #call(_context) ⇒ Array<Docscribe::Plugin::Tag>

  Generate additional tags for a documented method.

Instance Method Details

#call(_context) ⇒ Array<Docscribe::Plugin::Tag>

Generate additional tags for a documented method.

Called once per documented method. Return [] if this plugin has nothing to add for this particular method.

Parameters:

• context (Docscribe::Plugin::Context) —

  method context snapshot

• _context (Object) —

  Param documentation.

Returns:

• (Array<Docscribe::Plugin::Tag>)

# File 'lib/docscribe/plugin/base/tag_plugin.rb', line 32

def call(_context)
  []
end