Class: YARD::Handlers::Ruby::Legacy::ModuleFunctionHandler
- Defined in:
- lib/yard/handlers/ruby/legacy/module_function_handler.rb
Overview
Handles module_function calls to turn methods into public class methods. Also creates a private instance copy of the method.
Constant Summary
Constant Summary
Constants included from Parser::Ruby::Legacy::RubyToken
Parser::Ruby::Legacy::RubyToken::EXPR_ARG, Parser::Ruby::Legacy::RubyToken::EXPR_BEG, Parser::Ruby::Legacy::RubyToken::EXPR_CLASS, Parser::Ruby::Legacy::RubyToken::EXPR_DOT, Parser::Ruby::Legacy::RubyToken::EXPR_END, Parser::Ruby::Legacy::RubyToken::EXPR_FNAME, Parser::Ruby::Legacy::RubyToken::EXPR_MID, Parser::Ruby::Legacy::RubyToken::NEWLINE_TOKEN, Parser::Ruby::Legacy::RubyToken::TkReading2Token, Parser::Ruby::Legacy::RubyToken::TkSymbol2Token
Constants included from CodeObjects
CodeObjects::BUILTIN_ALL, CodeObjects::BUILTIN_CLASSES, CodeObjects::BUILTIN_EXCEPTIONS, CodeObjects::BUILTIN_EXCEPTIONS_HASH, CodeObjects::BUILTIN_MODULES, CodeObjects::CONSTANTMATCH, CodeObjects::CONSTANTSTART, CodeObjects::CSEP, CodeObjects::CSEPQ, CodeObjects::ISEP, CodeObjects::ISEPQ, CodeObjects::METHODMATCH, CodeObjects::METHODNAMEMATCH, CodeObjects::NAMESPACEMATCH, CodeObjects::NSEP, CodeObjects::NSEPQ
Instance Attribute Summary collapse
-
#extra_state ⇒ Object
inherited
from Base
readonly
Returns the value of attribute extra_state.
-
#globals ⇒ Object
inherited
from Base
readonly
Returns the value of attribute globals.
-
#namespace ⇒ Object
inherited
from Base
Returns the value of attribute namespace.
-
#owner ⇒ Object
inherited
from Base
Returns the value of attribute owner.
-
#parser ⇒ Processor
inherited
from Base
readonly
The processor object that manages all global state during handling.
-
#scope ⇒ Object
inherited
from Base
Returns the value of attribute scope.
-
#statement ⇒ Object
inherited
from Base
readonly
The statement object currently being processed.
-
#visibility ⇒ Object
inherited
from Base
Returns the value of attribute visibility.
Instance Method Summary collapse
-
#process ⇒ void
Main processing callback.
Constructor Details
This class inherits a constructor from YARD::Handlers::Base
Instance Attribute Details
#extra_state ⇒ Object (readonly) Originally defined in class Base
Returns the value of attribute extra_state
#globals ⇒ Object (readonly) Originally defined in class Base
Returns the value of attribute globals
#namespace ⇒ Object Originally defined in class Base
Returns the value of attribute namespace
#owner ⇒ Object Originally defined in class Base
Returns the value of attribute owner
#parser ⇒ Processor (readonly) Originally defined in class Base
Returns the processor object that manages all global state during handling.
#scope ⇒ Object Originally defined in class Base
Returns the value of attribute scope
#statement ⇒ Object (readonly) Originally defined in class Base
Returns the statement object currently being processed. Usually refers to one semantic language statement, though the strict definition depends on the parser used.
#visibility ⇒ Object Originally defined in class Base
Returns the value of attribute visibility
Instance Method Details
#process ⇒ void
This method returns an undefined value.
Main processing callback
6 7 8 9 10 11 12 13 14 15 16 17 |
# File 'lib/yard/handlers/ruby/legacy/module_function_handler.rb', line 6 process do if statement.tokens.size == 1 self.scope = :module else tokval_list(statement.tokens[2..-1], :attr).each do |name| instance_method = MethodObject.new(namespace, name) class_method = MethodObject.new(namespace, name, :module) instance_method.copy_to(class_method) class_method.visibility = :public end end end |