path: root/lib/rdoc/README
diff options
Diffstat (limited to 'lib/rdoc/README')
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.
lines up to the next blank line in the comment are treated as
the method's calling sequence, overriding the