summaryrefslogtreecommitdiff
path: root/lib/rdoc/markup.rb
diff options
context:
space:
mode:
authordrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2011-02-05 06:20:57 +0000
committerdrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2011-02-05 06:20:57 +0000
commit8aa895294b8d696489b51a5e69b2986f452da905 (patch)
tree085fe578ab276ff3be423448a4b9407c60a6dc51 /lib/rdoc/markup.rb
parentd8ebf3829f24fcb05ff47a12a9bb83e8b993aeae (diff)
Import RDoc 3.5.2
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@30795 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/rdoc/markup.rb')
-rw-r--r--lib/rdoc/markup.rb14
1 files changed, 9 insertions, 5 deletions
diff --git a/lib/rdoc/markup.rb b/lib/rdoc/markup.rb
index 9a2e7f2ca8..73de2d06f8 100644
--- a/lib/rdoc/markup.rb
+++ b/lib/rdoc/markup.rb
@@ -502,10 +502,11 @@ require 'rdoc'
# 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. 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:
+# attributes, 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
@@ -513,7 +514,10 @@ require 'rdoc'
# # See it glisten in the noon-day sun.
# # ----------------------------------------
#
-# <i>Note: Current formatters to not take sections into account.</i>
+# Sections may be referenced multiple times in a class or module allowing
+# methods, attributes and constants to be ordered one way for implementation
+# ordering but still grouped together in documentation. If a section has
+# multiple comments they will be concatenated with a dividing rule.
#
# [+:call-seq:+]
# Lines up to the next blank line in the comment are treated as the method's