Class: RDoc::RI::ModuleDescription

Inherits:
Description show all
Defined in:
lib/rdoc/ri/descriptions.rb

Direct Known Subclasses

ClassDescription

Instance Attribute Summary collapse

Attributes inherited from Description

#comment, #full_name, #name

Instance Method Summary collapse

Methods inherited from Description

#<=>, deserialize, #serialize

Instance Attribute Details

#attributes ⇒ Object

Returns the value of attribute attributes.



82
83
84
 
# File 'lib/rdoc/ri/descriptions.rb', line 82

def attributes
  @attributes
end

#class_methods ⇒ Object

Returns the value of attribute class_methods.



80
81
82
 
# File 'lib/rdoc/ri/descriptions.rb', line 80

def class_methods
  @class_methods
end

#constants ⇒ Object

Returns the value of attribute constants.



83
84
85
 
# File 'lib/rdoc/ri/descriptions.rb', line 83

def constants
  @constants
end

#includes ⇒ Object

Returns the value of attribute includes.



84
85
86
 
# File 'lib/rdoc/ri/descriptions.rb', line 84

def includes
  @includes
end

#instance_methods ⇒ Object

Returns the value of attribute instance_methods.



81
82
83
 
# File 'lib/rdoc/ri/descriptions.rb', line 81

def instance_methods
  @instance_methods
end

Instance Method Details

#display_name ⇒ Object 



103
104
105
 
# File 'lib/rdoc/ri/descriptions.rb', line 103

def display_name
    "Module"
end

#merge_in(old) ⇒ Object

merge in another class desscription into this one



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/rdoc/ri/descriptions.rb', line 87

def merge_in(old)
  merge(@class_methods, old.class_methods)
  merge(@instance_methods, old.instance_methods)
  merge(@attributes, old.attributes)
  merge(@constants, old.constants)
  merge(@includes, old.includes)
  if @comment.nil? || @comment.empty?
    @comment = old.comment
  else
    unless old.comment.nil? or old.comment.empty? then
      @comment << RDoc::Markup::Flow::RULE.new
      @comment.concat old.comment
    end
  end
end

#superclass_string ⇒ Object

the ‘ClassDescription’ subclass overrides this to format up the name of a parent



109
110
111
 
# File 'lib/rdoc/ri/descriptions.rb', line 109

def superclass_string
  nil
end