Class: YARD::MRuby::CodeObjects::HeaderObject

Inherits:
CodeObjects::NamespaceObject
  • Object
show all
Defined in:
lib/yard/mruby/code_objects/header_object.rb

Overview

A HeaderObject represents a MRuby header inside an include directory It groups C Functions and define macros.

Instance Method Summary collapse

Instance Method Details

#defines ⇒ Object 



10
11
12
 
# File 'lib/yard/mruby/code_objects/header_object.rb', line 10

def defines
  children.find_all {|d| d.is_a?(DefineObject) } 
end

#functions ⇒ Object 



6
7
8
 
# File 'lib/yard/mruby/code_objects/header_object.rb', line 6

def functions
  children.find_all {|d| d.is_a?(FunctionObject) } 
end

#inheritance_tree(*args) ⇒ Object 



26
27
28
 
# File 'lib/yard/mruby/code_objects/header_object.rb', line 26

def inheritance_tree(*args)
  return [self]
end

#path ⇒ Object 



18
19
20
 
# File 'lib/yard/mruby/code_objects/header_object.rb', line 18

def path
  self.name
end

#title ⇒ Object 



22
23
24
 
# File 'lib/yard/mruby/code_objects/header_object.rb', line 22

def title
  super.to_s
end

#typedefs ⇒ Object 



14
15
16
 
# File 'lib/yard/mruby/code_objects/header_object.rb', line 14

def typedefs
  children.find_all {|d| d.is_a?(TypedefObject) }
end