Class: YARD::Handlers::C::ClassHandler

Inherits:

Base

• Object
• Base
• Base
• YARD::Handlers::C::ClassHandler

show all

Defined in:

lib/yard/handlers/c/class_handler.rb

Overview

Constant Summary

MATCH1 =

Since:

• 0.8.0

/([\w\.]+)\s* = \s*(?:rb_define_class|boot_defclass)\s*
\(
   \s*"([\w:]+)",
   \s*(\w+|0)\s*
\)/mx

MATCH2 =

Since:

• 0.8.0

/([\w\.]+)\s* = \s*rb_define_class_under\s*
\(
   \s*(\w+),
   \s*"(\w+)"(?:,
   \s*([\w\*\s\(\)\.\->]+)\s*)?  # for SWIG
\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::CSEP, CodeObjects::CSEPQ, CodeObjects::ISEP, CodeObjects::ISEPQ, CodeObjects::METHODMATCH, CodeObjects::METHODNAMEMATCH, CodeObjects::NAMESPACEMATCH, CodeObjects::NSEP, CodeObjects::NSEPQ

Instance Attribute Summary (collapse)

• - (Object) extra_state inherited from Base readonly

  Returns the value of attribute extra_state.

• - (Object) globals inherited from Base readonly

  Returns the value of attribute globals.

• - (Object) namespace inherited from Base

  Returns the value of attribute namespace.

• - (Object) owner inherited from Base

  Returns the value of attribute owner.

• - (Processor) parser inherited from Base readonly

  The processor object that manages all global state during handling.

• - (Object) scope inherited from Base

  Returns the value of attribute scope.

• - (Object) statement inherited from Base readonly

  The statement object currently being processed.

• - (Object) visibility inherited from Base

  Returns the value of attribute visibility.

Instance Method Summary (collapse)

• - (void) process

  Main processing callback.

Methods included from HandlerMethods

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

18
19
20
21
22
23
24
25

# File 'lib/yard/handlers/c/class_handler.rb', line 18

process do
  statement.source.scan(MATCH1) do |var_name, class_name, parent|
    handle_class(var_name, class_name, parent)
  end
  statement.source.scan(MATCH2) do |var_name, in_module, class_name, parent|
    handle_class(var_name, class_name, parent, in_module)
  end
end