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

Inherits:

Base

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

Defined in:

lib/yard/handlers/c/class_handler.rb

Overview

Since:

• 0.8.0

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::CONSTANTSTART, CodeObjects::CSEP, CodeObjects::CSEPQ, CodeObjects::ISEP, CodeObjects::ISEPQ, CodeObjects::METHODMATCH, CodeObjects::METHODNAMEMATCH, CodeObjects::NAMESPACEMATCH, CodeObjects::NSEP, CodeObjects::NSEPQ, CodeObjects::PROXY_MATCH

Instance Attribute Summary

Attributes inherited from Base

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

Instance Method Summary

• #process ⇒ void

  Main processing callback.

Methods inherited from Base

#ensure_variable_defined!, handles?, #namespace_for_variable, #namespaces, #override_comments, #parse_block, #process_file, #processed_files, #register_docstring, #register_file_info, #register_source, #register_visibility, statement_class, #symbols

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, on_invalidate, #register_separator, #separators, #separators_for_type, #separators_match, #types_for_separator, #unregister_separator_by_type

Methods inherited from Base

#abort!, #call_params, #caller_method, clear_subclasses, #ensure_loaded!, handlers, handles, handles?, in_file, inherited, #initialize, matches_file?, namespace_only, namespace_only?, #parse_block, process, #push_state, #register, #register_docstring, #register_dynamic, #register_ensure_loaded, #register_file_info, #register_group, #register_module_function, #register_source, #register_transitive_tags, #register_visibility, subclasses

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/class_handler.rb', line 19

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.strip, in_module)
  end
end