diff options
| author | dave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-04-02 01:20:58 +0000 |
|---|---|---|
| committer | dave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-04-02 01:20:58 +0000 |
| commit | 354d68f80b1e92f58c13004e13dec48b179d2b4d (patch) | |
| tree | 90dc42fcaf210fab6d590538d642a90da03c37c3 /lib/rdoc/README | |
| parent | 88e112024905251acaf8dacd0a1ef254060f4a52 (diff) | |
Fix parse bug with toplevel methods. Allow RDoc in =begin rdoc/=end comments (experimental)
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@6066 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/rdoc/README')
| -rw-r--r-- | lib/rdoc/README | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/lib/rdoc/README b/lib/rdoc/README index 0c10d0ea69..6e234e31a5 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. |