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

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

Overview

Parses comments

Since:

  • 0.8.0

Constant Summary

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
21
22
# 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) ⇒ Object

Since:

  • 0.8.0


24
25
26
# 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) ⇒ Object

Since:

  • 0.8.0


28
29
30
# 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