diff options
| author | dave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-11-20 15:02:57 +0000 |
|---|---|---|
| committer | dave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-11-20 15:02:57 +0000 |
| commit | a80ba17d67141a51459bb89b1fb51e8b0a4ff2de (patch) | |
| tree | 07dbf3a174284bb23462ce5109658ea56466207a /lib/rdoc/README | |
| parent | aafc487d6a461d0a729432f919af0ee9645fcf14 (diff) | |
| download | ruby-a80ba17d67141a51459bb89b1fb51e8b0a4ff2de.tar.gz | |
1. Force --inline-source if --one-file given
2. Add new :section: directive which starts a new section in the output.
The title following :section: 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.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@7344 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/rdoc/README')
| -rw-r--r-- | lib/rdoc/README | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/lib/rdoc/README b/lib/rdoc/README index 5e90d792a2..583f7f3b0c 100644 --- a/lib/rdoc/README +++ b/lib/rdoc/README @@ -422,6 +422,13 @@ this margin are formatted verbatim. 12. Comment blocks can contain other directives: + [<tt>:section: title</tt>] + Starts a new section in the output. The title following + <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. + [<tt>call-seq:</tt>] lines up to the next blank line in the comment are treated as the method's calling sequence, overriding the |