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 | ef38efca9f4835ee2306f9b56eb26a2eaa14dc7a (patch) | |
| tree | a5cafd6b8942aacdb00d97541eaeaa9e9ded6a3c /lib/rdoc/README | |
| parent | 64ec09d45675fa8a12594c00b8b4acccf9960fce (diff) | |
| download | ruby-ef38efca9f4835ee2306f9b56eb26a2eaa14dc7a.tar.gz | |
Fix parse bug with toplevel methods. Allow RDoc in =begin rdoc/=end comments (experimental)
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@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. |