diff options
| author | dave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-12-04 05:38:17 +0000 |
|---|---|---|
| committer | dave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-12-04 05:38:17 +0000 |
| commit | e28c8d2c52abb939e8a0d50d29b111438129b869 (patch) | |
| tree | 5a55c360dcac53469d4de426528edc1a0e3a4a6a /lib/rdoc/README | |
| parent | b70ab3ad132d2cc1ab2b0808bdf0eca603278ca2 (diff) | |
Ignore leading and trailing lines in :section: blocks
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@7455 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/rdoc/README')
| -rw-r--r-- | lib/rdoc/README | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/lib/rdoc/README b/lib/rdoc/README index 583f7f3b0c..60650dd88b 100644 --- a/lib/rdoc/README +++ b/lib/rdoc/README @@ -427,7 +427,17 @@ this margin are formatted verbatim. <tt>:section:</tt> is used as the section heading, and the remainder of the comment containing the section is used as introductory text. Subsequent methods, aliases, attributes, - and classes will be documented in this section. + and classes will be documented in this section. A :section: + comment block may have one or more lines before the :section: + directive. These will be removed, and any identical lines at + the end of the block are also removed. This allows you to add + visual cues such as + + # ---------------------------------------- + # :section: My Section + # This is the section that I wrote. + # See it glisten in the noon-day sun. + # ---------------------------------------- [<tt>call-seq:</tt>] lines up to the next blank line in the comment are treated as |