Fix loop termination when looking for the modifier comment of a class alias. Fixes issue #51

Author: drbrain

History.txt

@@ -6,8 +6,8 @@
   * `ri []` and other special methods now work properly.  Issue #52 by
     ddebernardy.
   * `ri` now has space between class comments from multiple files.
-  * The stopdoc directive no longer creates Object references.  Issue #55 by
-    Simon Chiang
+  * :stopdoc: no longer creates Object references.  Issue #55 by Simon Chiang
+  * :nodoc: works on class aliases now.  Issue #51 by Steven G. Harms
 
 === 3.8 / 2011-06-29
 

lib/rdoc/class_module.rb

@@ -222,6 +222,9 @@ def full_name
                    end
   end
 
+  ##
+  # TODO: filter included items by #display?
+
   def marshal_dump # :nodoc:
     attrs = attributes.sort.map do |attr|
       [ attr.name, attr.rw,

lib/rdoc/generator/template/darkfish/classpage.rhtml

@@ -176,6 +176,8 @@
     </div><!-- description -->
 
     <% klass.each_section do |section, constants, attributes| %>
+    <% constants = constants.select { |const| const.display? } %>
+    <% attributes = attributes.select { |attr| attr.display? } %>
     <div id="<%= section.aref %>" class="documentation-section">
       <% if section.title then %>
       <h2 class="section-header">

lib/rdoc/markup/pre_process.rb

@@ -118,7 +118,7 @@ def handle_directive prefix, directive, param, code_object = nil,
     when 'nodoc' then
       return blankline unless code_object
       code_object.document_self = nil # notify nodoc
-      code_object.document_children = param.to_s.downcase != 'all'
+      code_object.document_children = param !~ /all/i
 
       blankline
     when 'notnew', 'not_new', 'not-new' then

lib/rdoc/parser/ruby.rb

@@ -701,7 +701,8 @@ def parse_constant container, tk, comment
       when TkRPAREN, TkRBRACE, TkRBRACK, TkEND then
         nest -= 1
       when TkCOMMENT then
-        if nest <= 0 && @scanner.lex_state == EXPR_END
+        if nest <= 0 &&
+           (@scanner.lex_state == EXPR_END || !@scanner.continue) then
           unget_tk tk
           break
         end
@@ -716,7 +717,6 @@ def parse_constant container, tk, comment
                 end
 
           container.add_module_alias mod, name, @top_level if mod
-          get_tk # TkNL
           break
         end
       when TkNL then

test/test_rdoc_parser_ruby.rb

@@ -2193,6 +2193,25 @@ def method_name
     assert @top_level.find_module_named('Example').ignored?
   end
 
+  # This tests parse_comment
+  def test_parse_top_level_statements_constant_nodoc_integration
+    content = <<-CONTENT
+class A
+  C = A # :nodoc:
+end
+    CONTENT
+
+    util_parser content
+
+    @parser.parse_top_level_statements @top_level
+
+    klass = @top_level.find_module_named('A')
+
+    c = klass.constants.first
+
+    assert_nil c.document_self, 'C should not be documented'
+  end
+
   def test_parse_yield_in_braces_with_parens
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level