Module: PDoc::Models::Container

Included in:
Class, Mixin, Namespace, Root, Section
Defined in:
lib/pdoc/models/container.rb

Instance Method Summary collapse

Instance Method Details

#children ⇒ Object 



4
5
6
 
# File 'lib/pdoc/models/container.rb', line 4

def children
  @children ||= []
end

#children? ⇒ Boolean

Returns:

  • (Boolean) 


8
9
10
 
# File 'lib/pdoc/models/container.rb', line 8

def children?
  @children && !@children.empty?
end

#class_methods ⇒ Object 



65
66
67
 
# File 'lib/pdoc/models/container.rb', line 65

def class_methods
  @class_methods ||= []
end

#class_methods? ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/pdoc/models/container.rb', line 69

def class_methods?
  @class_methods && !@class_methods.empty?
end

#class_properties ⇒ Object 



73
74
75
 
# File 'lib/pdoc/models/container.rb', line 73

def class_properties
  @class_properties ||= []
end

#class_properties? ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/pdoc/models/container.rb', line 77

def class_properties?
  @class_properties && !@class_properties.empty?
end

#classes ⇒ Object

returns an array of Class objects belonging to this section



22
23
24
 
# File 'lib/pdoc/models/container.rb', line 22

def classes
  @classes ||= []
end

#classes? ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
 
# File 'lib/pdoc/models/container.rb', line 26

def classes?
  @classes && !@classes.empty?
end

#constants ⇒ Object

returns an array of constants objects belonging to this section



57
58
59
 
# File 'lib/pdoc/models/container.rb', line 57

def constants
  @constants ||= []
end

#constants? ⇒ Boolean

Returns:

  • (Boolean) 


61
62
63
 
# File 'lib/pdoc/models/container.rb', line 61

def constants?
  @constants && !@constants.empty?
end

#included_mixins ⇒ Object 



39
40
41
 
# File 'lib/pdoc/models/container.rb', line 39

def included_mixins
  @included_mixins ||= []
end

#included_mixins? ⇒ Boolean

Returns:

  • (Boolean) 


43
44
45
 
# File 'lib/pdoc/models/container.rb', line 43

def included_mixins?
  @included_mixins && !@included_mixins.empty?
end

#instance_methods ⇒ Object 



81
82
83
 
# File 'lib/pdoc/models/container.rb', line 81

def instance_methods
  @instance_methods ||= []
end

#instance_methods? ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/pdoc/models/container.rb', line 85

def instance_methods?
  @instance_methods && !@instance_methods.empty?
end

#instance_properties ⇒ Object 



89
90
91
 
# File 'lib/pdoc/models/container.rb', line 89

def instance_properties
  @instance_properties ||= []
end

#instance_properties? ⇒ Boolean

Returns:

  • (Boolean) 


93
94
95
 
# File 'lib/pdoc/models/container.rb', line 93

def instance_properties?
  @instance_properties && !@instance_properties.empty?
end

#mixins ⇒ Object

returns an array of Mixin objects belonging to this section



31
32
33
 
# File 'lib/pdoc/models/container.rb', line 31

def mixins
  @mixins ||= []
end

#mixins? ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/pdoc/models/container.rb', line 35

def mixins?
  @mixins && !@mixins.empty?
end

#namespaces ⇒ Object

returns an array of Namespace objects belonging to this section



13
14
15
 
# File 'lib/pdoc/models/container.rb', line 13

def namespaces
  @namespaces ||= []
end

#namespaces? ⇒ Boolean

Returns:

  • (Boolean) 


17
18
19
 
# File 'lib/pdoc/models/container.rb', line 17

def namespaces?
  @namespaces && !@namespaces.empty?
end

#to_hash ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/pdoc/models/container.rb', line 97

def to_hash
  super.merge({
    :children => children.map { |obj| obj.id },
    :namespaces => namespaces.map { |obj| obj.id },
    :classes => classes.map { |obj| obj.id },
    :mixins => mixins.map { |obj| obj.id },
    :included_mixins => included_mixins.map { |obj| obj.id },
    :utilities => utilities.map { |obj| obj.id },
    :constants => constants.map { |obj| obj.id },
    :class_methods => class_methods.map { |obj| obj.id },
    :class_properties => class_properties.map { |obj| obj.id },
    :instance_methods => instance_methods.map { |obj| obj.id },
    :instance_properties => instance_properties.map { |obj| obj.id }
  })
end

#utilities ⇒ Object

returns an array of Function objects belonging to this section



48
49
50
 
# File 'lib/pdoc/models/container.rb', line 48

def utilities
  @utilities ||= []
end

#utilities? ⇒ Boolean

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/pdoc/models/container.rb', line 52

def utilities?
  @utilities && !@utilities.empty?
end