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

1 files changed, 34 insertions, 1 deletions

diff --git a/lib/rdoc/code_objects.rb b/lib/rdoc/code_objects.rb
index bd713ab92b..134ac398e9 100644
--- a/lib/rdoc/code_objects.rb
+++ b/lib/rdoc/code_objects.rb
@@ -23,6 +23,9 @@ module RDoc
 
     attr_accessor :done_documenting
 
+    # Which section are we in
+
+    attr_accessor :section
 
     # do we document ourselves?
 
@@ -111,7 +114,25 @@ module RDoc
   class Context < CodeObject
     attr_reader   :name, :method_list, :attributes, :aliases, :constants
     attr_reader   :requires, :includes, :in_files, :visibility
-    
+
+    attr_reader   :sections
+
+    class Section
+      attr_reader :title, :comment, :sequence
+
+      @@sequence = "SEC00000"
+
+      def initialize(title, comment)
+        @title = title
+        @@sequence.succ!
+        @sequence = @@sequence.dup
+        if comment
+          @comment = comment.sub(/.*$/, '')
+          @comment = nil if @comment.empty?
+        end
+      end
+    end
+
 
     def initialize
       super()
@@ -123,6 +144,9 @@ module RDoc
       @parent  = nil
       @visibility = :public
 
+      @current_section = Section.new(nil, nil)
+      @sections = [ @current_section ]
+
       initialize_methods_etc
       initialize_classes_and_modules
     end
@@ -236,6 +260,7 @@ module RDoc
 #        collection[name] = cls if @document_self  && !@done_documenting
         collection[name] = cls if !@done_documenting
         cls.parent = self
+        cls.section = @current_section
       end
       cls
     end
@@ -243,6 +268,7 @@ module RDoc
     def add_to(array, thing)
       array <<  thing if @document_self  && !@done_documenting
       thing.parent = self
+      thing.section = @current_section
     end
 
     # If a class's documentation is turned off after we've started
@@ -374,6 +400,13 @@ module RDoc
             find_module_named(symbol) 
     end
 
+    # Handle sections
+
+    def set_current_section(title, comment)
+      @current_section = Section.new(title, comment)
+      @sections << @current_section
+    end
+
     private
 
     # Find a named method, or return nil