From 5c4872b0ca73232dc701d86e6d76194d5fc6255e Mon Sep 17 00:00:00 2001
From: dave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Fri, 2 Apr 2004 01:20:58 +0000
Subject: Fix parse bug with toplevel methods. Allow RDoc in =begin rdoc/=end
 comments (experimental)

git-svn-id: http://svn.ruby-lang.org/repos/ruby/branches/ruby_1_8@6066 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 lib/rdoc/README | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

(limited to 'lib/rdoc/README')

diff --git a/lib/rdoc/README b/lib/rdoc/README
index 0c10d0ea6..6e234e31a 100644
--- a/lib/rdoc/README
+++ b/lib/rdoc/README
@@ -240,7 +240,15 @@ can see the formatted result in EXAMPLE.rb and Anagram.
 
 = Markup
 
-Comment blocks can be written fairly naturally. 
+Comment blocks can be written fairly naturally, either using '#' on
+successive lines of the comment, or by including the comment in 
+an =begin/=end block. If you use the latter form, the =begin line
+must be flagged with an RDoc tag:
+
+  =begin rdoc
+  Documentation to 
+  be processed by RDoc.
+  =end
 
 Paragraphs are lines that share the left margin. Text indented past
 this margin are formatted verbatim.
-- 
cgit