123456789_123456789_123456789_123456789_123456789_

Class: YARD::Handlers::C::OverrideCommentHandler

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
Instance Chain:
Inherits: YARD::Handlers::C::Base
Defined in: lib/yard/handlers/c/override_comment_handler.rb

Overview

Parses comments

Since:

  • 0.8.0

Constant Summary

::YARD::CodeObjects - Included

BUILTIN_ALL, BUILTIN_CLASSES, BUILTIN_EXCEPTIONS, BUILTIN_EXCEPTIONS_HASH, BUILTIN_MODULES, CONSTANTMATCH, CONSTANTSTART, CSEP, CSEPQ, ISEP, ISEPQ, METHODMATCH, METHODNAMEMATCH, NAMESPACEMATCH, NSEP, NSEPQ, PROXY_MATCH

Base - Inherited

ERROR_CLASS_NAMES

Class Attribute Summary

::YARD::Handlers::Base - Inherited

.namespace_only

Declares that the handler should only be called when inside a ::YARD::CodeObjects::NamespaceObject, not a method body.

.namespace_only?

Class Method Summary

Base - Inherited

::YARD::Handlers::Base - Inherited

.clear_subclasses

Clear all registered subclasses.

.handlers,
.handles

Declares the statement type which will be processed by this handler.

.handles?
.in_file

Declares that a handler should only be called when inside a filename by its basename or a regex match for the full path.

.inherited, .matches_file?, .new,
.process

Generates a #process method, equivalent to +def process; ...

.subclasses

Returns all registered handler subclasses.

Instance Attribute Summary

::YARD::Handlers::Base - Inherited

#extra_state

Share state across different handlers inside of a file.

#globals

::YARD::Handlers can share state for the entire post processing stage through this attribute.

#namespace, #namespace=, #owner, #owner=, #parser, #scope, #scope=, #statement, #visibility, #visibility=

Instance Method Summary

Base - Inherited

HandlerMethods - Included

::YARD::Handlers::Common::MethodHandler - Included

::YARD::Handlers::Base - Inherited

#abort!

Aborts a handler by raising ::YARD::Handlers::HandlerAborted.

#call_params, #caller_method,
#ensure_loaded!

Ensures that a specific object has been parsed and loaded into the registry.

#parse_block

Parses the semantic "block" contained in the statement node.

#process

The main handler method called by the parser on a statement that matches the handles declaration.

#push_state

Executes a given block with specific state values for #owner, #namespace and #scope.

#register

Do some post processing on a list of code objects.

#register_docstring

Registers any docstring found for the object and expands macros.

#register_dynamic

Registers the object as dynamic if the object is defined inside a method or block (owner != namespace).

#register_ensure_loaded

Ensures that the object's namespace is loaded before attaching it to the namespace.

#register_file_info

Registers the file/line of the declaration with the object.

#register_group

Registers the object as being inside a specific group.

#register_module_function

Registers the same method information on the module function, if the object was defined as a module function.

#register_source,
#register_transitive_tags

Registers any transitive tags from the namespace on the object.

#register_visibility

Registers visibility on a method object.

Constructor Details

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

Instance Method Details

#processvoid

This method returns an undefined value.

Main processing callback

[ GitHub ]

  
# File 'lib/yard/handlers/c/override_comment_handler.rb', line 7

process do
  return if statement.overrides.empty?
  statement.overrides.each do |type, name|
    override_comments << [name, statement]
    obj = nil
    case type
    when :class
      name, superclass = *name.split(/\s*<\s*/)
      obj = YARD::CodeObjects::ClassObject.new(:root, name)
      obj.superclass = "::#{superclass}" if superclass
    when :module
      obj = YARD::CodeObjects::ModuleObject.new(:root, name)
    end
    register(obj)
  end
end

#register_docstring(object, docstring = statement.source, stmt = statement)

Since:

  • 0.8.0

[ GitHub ]

  
# File 'lib/yard/handlers/c/override_comment_handler.rb', line 24

def register_docstring(object, docstring = statement.source, stmt = statement)
  super
end

#register_file_info(object, file = parser.file, line = statement.line, comments = statement.comments)

Since:

  • 0.8.0

[ GitHub ]

  
# File 'lib/yard/handlers/c/override_comment_handler.rb', line 28

def register_file_info(object, file = parser.file, line = statement.line, comments = statement.comments)
  super
end