Class: YARD::Handlers::Ruby::ProcessHandler

Inherits:
Base
  • Object
show all
Defined in:
lib/yard/handlers/ruby/process_handler.rb

Overview

This is a YARD-specific handler for handler DSL syntax. It handles the "process do ... end" syntax and translates it into a "def process; end" method declaration.

Since:

Constant Summary

Instance Attribute Summary

Attributes inherited from Base

#namespace, #owner, #parser, #scope, #statement, #visibility

Instance Method Summary (collapse)

Methods inherited from Base

handles?, meta_type, method_call, #parse_block

Methods included from Parser::Ruby

#s

Methods inherited from Base

clear_subclasses, #ensure_loaded!, handlers, handles, handles?, #initialize, namespace_only, namespace_only?, #parse_block, process, #push_state, #register, subclasses

Constructor Details

This class inherits a constructor from YARD::Handlers::Base

Instance Method Details

- (Object) process

Main processing callback

Since:

  • 0.5.4



10
11
12
13
14
15
16
17
 
# File 'lib/yard/handlers/ruby/process_handler.rb', line 10

process do
  return unless namespace.is_a?(ClassObject) && namespace.superclass.to_s =~ /^YARD::Handlers/
  register MethodObject.new(namespace, :process) do |o|
    o.docstring = "Main processing callback"
    o.signature = "def process"
    o.parameters = []
  end
end