Class: YARD::Handlers::C::MixinHandler

Inherits:
Base
  • Object
show all
Defined in:
lib/yard/handlers/c/mixin_handler.rb

Overview

Since:

  • 0.8.0

Constant Summary collapse

MATCH =

Since:

  • 0.8.0

/rb_include_module\s*\(\s*(\w+?),\s*(\w+?)\s*\)/

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 collapse

Methods included from HandlerMethods

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

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

#processvoid

This method returns an undefined value.

Main processing callback


7
8
9
10
11
12
13
14
15
16
17
18
19
20
# File 'lib/yard/handlers/c/mixin_handler.rb', line 7

process do
  statement.source.scan(MATCH) do |klass_var, mixin_var|
    namespace = namespace_for_variable(klass_var)
    ensure_loaded!(namespace)

    var = namespace_for_variable(mixin_var)
    if var
      namespace.mixins(:instance) << var
    else
      raise YARD::Parser::UndocumentableError,
        "CRuby mixin for unrecognized variable '#{mixin_var}'"
    end
  end
end