Fix the horizontal rule markup.

Author: DesigningPatterns

History.txt

@@ -33,7 +33,7 @@ documentation about ri.
   * Provided an ri command-line option to control its caching behavior.
   * Improved RDoc's documentation.  Added RI.txt to document ri.
 
-* 25 Bug fixes:
+* 26 Bug fixes:
   * Fixed prototype detection in C parser.  Can process ruby 1.8 C files
     again.
   * Fixed the main page for frameless template.  Patch by Marcin Raczkowski.
@@ -74,6 +74,8 @@ documentation about ri.
   * Stopped the XML template from generating invalid XML due to malformed
     embedded ruby.
   * Adding missing information about a class' constants to the XML template.
+  * Fixed the horizontal rule markup (---) so that it correctly adds a
+    horizontal rule rather than suppressing all text that follows.
 
 === 2.1.0 / 2008-07-20
 

README.txt

@@ -32,14 +32,21 @@ and used with the +-T+ option.
   # ... see RDoc
 
 == BUGS:
-
+---
 RDoc's Fortran 95 support is pretty broken right now.
 The rdoc-f95[http://www.gfd-dennou.org/library/dcmodel/rdoc-f95/] project has
 patches for RDoc 1.x that provide excellent Fortran 95 support.  Properly
 supporting Fortran 95 requires a rewrite of RDoc's markup engine, which
 is high on our list of goals.  The Fortran 95 issue can be tracked
 here[http://rubyforge.org/tracker/index.php?func=detail&aid=21542&group_id=627&atid=2475].
-
+---
+The markup engine has lots of little bugs.  In particular:
+* Escaping does not work for all markup.
+* Typesetting is not always correct.
+* Some output formats (ri, for example) do not correctly handle all of the
+  markup.
+The markup engine needs a rewrite, which can be tracked here[http://rubyforge.org/tracker/index.php?func=detail&aid=21540&group_id=627&atid=2475].
+-------
 If you find a bug, please report it at the RDoc project's
 tracker[http://rubyforge.org/tracker/?group_id=627] on RubyForge:
 

lib/rdoc/parser/c.rb

@@ -626,8 +626,8 @@ def remove_commented_out_lines
   end
 
   def remove_private_comments(comment)
-     comment.gsub!(/\/?\*--(.*?)\/?\*\+\+/m, '')
-     comment.sub!(/\/?\*--.*/m, '')
+     comment.gsub!(/\/?\*--\n(.*?)\/?\*\+\+/m, '')
+     comment.sub!(/\/?\*--\n.*/m, '')
   end
 
   ##

lib/rdoc/parser/ruby.rb

@@ -2683,8 +2683,8 @@ def read_documentation_modifiers(context, allow)
   end
 
   def remove_private_comments(comment)
-    comment.gsub!(/^#--.*?^#\+\+/m, '')
-    comment.sub!(/^#--.*/m, '')
+    comment.gsub!(/^#--\n.*?^#\+\+/m, '')
+    comment.sub!(/^#--\n.*/m, '')
   end
 
   def remove_token_listener(obj)

lib/rdoc/parser/simple.rb

@@ -31,7 +31,7 @@ def scan
   end
 
   def remove_private_comments(comment)
-    comment.gsub(/^--[^-].*?^\+\+/m, '').sub(/^--.*/m, '')
+    comment.gsub(/^--\n.*?^\+\+/m, '').sub(/^--\n.*/m, '')
   end
 
 end