Fix rdoc -C for ignored classes and modules.

Add missing documentation

Author: drbrain

lib/rdoc/rd/block_parser.ry

@@ -526,7 +526,7 @@ end
 private :set_term_to_element
 
 ##
-# Raises a ParseError
+# Raises a ParseError when invalid formatting is found
 
 def on_error(et, ev, _values)
   prv, cur, nxt = format_line_num(@i, @i+1, @i+2)

lib/rdoc/rd/inline_parser.ry

@@ -422,25 +422,28 @@ OTHER_RE = Regexp.new(
 
 # :startdoc:
 
+##
+# Creates a new parser for inline markup in the rd format.  The +block_parser+
+# is used to for footnotes and labels in the inline text.
+
 def initialize block_parser
   @block_parser = block_parser
 end
 
+##
+# Parses the +inline+ text from RD format into RDoc format.
+
 def parse inline
   @inline = inline
   @src = StringScanner.new inline
   @pre = ""
   @yydebug = true
   do_parse.to_s
-rescue
-  puts $!
-  puts
-  puts @inline[0, @src.pos].inspect
-  puts @src.rest[0..40]
-  puts
-  raise
 end
 
+##
+# Returns the next token from the inline text
+
 def next_token
   return [false, false] if @src.eos?
 #  p @src.rest if @yydebug
@@ -518,6 +521,9 @@ def next_token
   end
 end
 
+##
+# Raises a ParseError when invalid formatting is found
+
 def on_error(et, ev, values)
   lines_of_rest = @src.rest.lines.to_a.length
   prev_words = prev_words_on_error(ev)
@@ -532,6 +538,9 @@ RD syntax error: line #{@block_parser.line_index - lines_of_rest}:
   raise ParseError, message
 end
 
+##
+# Returns words before the error
+
 def prev_words_on_error(ev)
   pre = @pre
   if ev and /#{Regexp.quote(ev)}$/ =~ pre
@@ -540,6 +549,9 @@ def prev_words_on_error(ev)
   last_line(pre)
 end
 
+##
+# Returns the last line of +src+
+
 def last_line(src)
   if n = src.rindex("\n")
     src[(n+1) .. -1]
@@ -549,6 +561,9 @@ def last_line(src)
 end
 private :last_line
 
+##
+# Returns words following an error
+
 def next_words_on_error
   if n = @src.rest.index("\n")
     @src.rest[0 .. (n-1)]
@@ -557,6 +572,9 @@ def next_words_on_error
   end
 end
 
+##
+# Creates a new RDoc::RD::Inline for the +rdoc+ markup and the raw +reference+
+
 def inline rdoc, reference = rdoc
   RDoc::RD::Inline.new rdoc, reference
 end

lib/rdoc/ruby_lex.rb

@@ -20,14 +20,14 @@
 
 class RDoc::RubyLex
 
-  # :stopdoc:
-
   ##
   # Raised upon invalid input
 
   class Error < RDoc::Error
   end
 
+  # :stopdoc:
+
   extend Exception2MessageMapper
 
   def_exception(:AlreadyDefinedToken, "Already defined token(%s)")
@@ -55,11 +55,17 @@ def self.debug?
   end
 
   self.debug_level = 0
+  
+  # :startdoc:
 
-  def self.tokenize text, options
+  ##
+  # Returns an Array of +ruby+ tokens.  See ::new for a description of
+  # +options+.
+
+  def self.tokenize ruby, options
     tokens = []
 
-    scanner = RDoc::RubyLex.new text, options
+    scanner = RDoc::RubyLex.new ruby, options
     scanner.exception_on_syntax_error = true
 
     while token = scanner.token do
@@ -69,6 +75,10 @@ def self.tokenize text, options
     tokens
   end
 
+  ##
+  # Creates a new lexer for +content+.  +options+ is an RDoc::Options, only
+  # +tab_width is used.
+
   def initialize(content, options)
     lex_init
 
@@ -112,6 +122,8 @@ def initialize(content, options)
     @ltype = nil
   end
 
+  # :stopdoc:
+
   def inspect # :nodoc:
     "#<%s:0x%x pos %d lex_state %p space_seen %p>" % [
       self.class, object_id,

lib/rdoc/stats.rb

@@ -158,7 +158,8 @@ def coverage_level= level
   # Returns the length and number of undocumented items in +collection+.
 
   def doc_stats collection
-    [collection.length, collection.count { |item| not item.documented? }]
+    visible = collection.select { |item| item.display? }
+    [visible.length, visible.count { |item| not item.documented? }]
   end
 
   ##
@@ -266,6 +267,7 @@ def report_attributes cm
 
   def report_class_module cm
     return if cm.fully_documented? and @coverage_level.zero?
+    return unless cm.display?
 
     report = []
 

test/test_rdoc_parser_ruby.rb

@@ -2356,6 +2356,25 @@ class C
     assert_equal expected, m.comment.parse
   end
 
+  def test_scan_stopdoc
+    util_parser <<-RUBY
+class C
+  # :stopdoc:
+  class Hidden
+  end
+end
+    RUBY
+
+    @parser.scan
+
+    c = @top_level.classes.first
+
+    hidden = c.classes.first
+
+    refute hidden.document_self
+    assert hidden.ignored?
+  end
+
   def test_stopdoc_after_comment
     util_parser <<-EOS
       module Bar

test/test_rdoc_stats.rb

@@ -11,6 +11,26 @@ def setup
     @tl.parser = RDoc::Parser::Ruby
   end
 
+  def test_doc_stats
+    c = RDoc::CodeObject.new
+
+    assert_equal [1, 1], @s.doc_stats([c])
+  end
+
+  def test_doc_stats_documented
+    c = RDoc::CodeObject.new
+    c.comment = comment 'x'
+
+    assert_equal [1, 0], @s.doc_stats([c])
+  end
+
+  def test_doc_stats_display_eh
+    c = RDoc::CodeObject.new
+    c.ignore
+
+    assert_equal [0, 0], @s.doc_stats([c])
+  end
+
   def test_report_attr
     c = @tl.add_class RDoc::NormalClass, 'C'
     c.record_location @tl
@@ -266,6 +286,17 @@ class C
     assert_equal expected, report
   end
 
+  def test_report_class_module_ignore
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.ignore
+
+    RDoc::TopLevel.complete :public
+
+    report = @s.report_class_module c
+
+    assert_nil report
+  end
+
   def test_report_empty
     RDoc::TopLevel.complete :public