Class: YARD::Handlers::C::ModuleHandler

Inherits:

Base

• Object
• Base
• Base
• YARD::Handlers::C::ModuleHandler

Defined in:

lib/yard/handlers/c/module_handler.rb

Overview

Since:

• 0.8.0

Constant Summary

MATCH1 =

Since:

• 0.8.0

/([\w\.]+)\s* = \s*rb_define_module\s*\(\s*"([\w:]+)"\s*\)/mx

MATCH2 =

Since:

• 0.8.0

/([\w\.]+)\s* = \s*rb_define_module_under\s*\(\s*(\w+),\s*"(\w+)"\s*\)/mx

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 Method Summary

• #process ⇒ void

  Main processing callback.

Methods included from HandlerMethods

#handle_alias, #handle_attribute, #handle_class, #handle_constants, #handle_method, #handle_module

Methods included from YARD::Handlers::Common::MethodHandler

#add_predicate_return_tag

Methods included from CodeObjects::NamespaceMapper

#clear_separators, #default_separator, #register_separator, #separators, #separators_for_type, #separators_match, #types_for_separator

Constructor Details

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

Instance Method Details

#process ⇒ void

This method returns an undefined value.

Main processing callback

# File 'lib/yard/handlers/c/module_handler.rb', line 9

process do
  statement.source.scan(MATCH1) do |var_name, module_name|
    handle_module(var_name, module_name)
  end
  statement.source.scan(MATCH2) do |var_name, in_module, module_name|
    handle_module(var_name, module_name, in_module)
  end
end