Import RDoc 3

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@30249 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 32 insertions, 4 deletions

diff --git a/lib/rdoc/constant.rb b/lib/rdoc/constant.rb
index 908990855d..056ce130be 100644
--- a/lib/rdoc/constant.rb
+++ b/lib/rdoc/constant.rb
@@ -6,6 +6,13 @@ require 'rdoc/code_object'
 class RDoc::Constant < RDoc::CodeObject
 
   ##
+  # If this constant is an alias for a module or class,
+  # this is the RDoc::ClassModule it is an alias for.
+  # +nil+ otherwise.
+
+  attr_accessor :is_alias_for
+
+  ##
   # The constant's name
 
   attr_accessor :name
@@ -22,6 +29,7 @@ class RDoc::Constant < RDoc::CodeObject
     super()
     @name = name
     @value = value
+    @is_alias_for = nil
     self.comment = comment
   end
 
@@ -34,17 +42,28 @@ class RDoc::Constant < RDoc::CodeObject
     [parent_name, name] <=> [other.parent_name, other.name]
   end
 
+  ##
+  # Constants are equal when their #parent and #name is the same
+
   def == other
     self.class == other.class and
       @parent == other.parent and
       @name == other.name
   end
 
+  ##
+  # A constant is documented if it has a comment, or is an alias
+  # for a documented class or module.
+
+  def documented?
+    super or is_alias_for && is_alias_for.documented?
+  end
+
   def inspect # :nodoc:
-      "#<%s:0x%x %s::%s>" % [
-        self.class, object_id,
-        parent_name, @name,
-      ]
+    "#<%s:0x%x %s::%s>" % [
+      self.class, object_id,
+      parent_name, @name,
+    ]
   end
 
   ##
@@ -54,5 +73,14 @@ class RDoc::Constant < RDoc::CodeObject
     "#{@parent.path}##{@name}"
   end
 
+  def to_s # :nodoc:
+    parent_name = parent ? parent.full_name : '(unknown)'
+    if is_alias_for
+      "constant #{parent_name}::#@name -> #{is_alias_for}"
+    else
+      "constant #{parent_name}::#@name"
+    end
+  end
+
 end