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

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

Overview

Parses comments

Since:

Constant Summary

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

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Methods included from HandlerMethods

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

Constructor Details

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

Instance Attribute Details

- (Object) extra_state (readonly) Originally defined in class Base

Returns the value of attribute extra_state

- (Object) globals (readonly) Originally defined in class Base

Returns the value of attribute globals

- (Object) namespace Originally defined in class Base

Returns the value of attribute namespace

- (Object) owner Originally defined in class Base

Returns the value of attribute owner

- (Processor) parser (readonly) Originally defined in class Base

Returns the processor object that manages all global state during handling.

Returns:

  • (Processor)

    the processor object that manages all global state during handling.

- (Object) scope Originally defined in class Base

Returns the value of attribute scope

- (Object) statement (readonly) Originally defined in class Base

Returns the statement object currently being processed. Usually refers to one semantic language statement, though the strict definition depends on the parser used.

Returns:

  • (Object)

    the statement object currently being processed. Usually refers to one semantic language statement, though the strict definition depends on the parser used.

- (Object) visibility Originally defined in class Base

Returns the value of attribute visibility

Instance Method Details

- (void) process

This method returns an undefined value.

Main processing callback



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

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

- (Object) register_docstring(object, docstring = statement.source, stmt = statement)

Since:

  • 0.8.0



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

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

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

Since:

  • 0.8.0



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

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