rdoc 2.5 → 2.5.1

data/.autotest

@@ -10,7 +10,7 @@ Autotest.add_hook :initialize do |at|
     f = s.sub(/^test#{sep}/, '').sub(/\.rb$/, '').split(sep)
     f = f.map { |path| path.split(/_|(\d+)/).map { |seg| seg.capitalize }.join }
     f = f.map { |path| path =~ /^Test/ ? path : "Test#{path}"  }
-    f.join('::').sub('Rdoc', 'RDoc').sub('Ri', 'RI')
+    f.join('::').gsub('Rdoc', 'RDoc').gsub('Ri', 'RI')
   end
 end
 

data/History.txt

@@ -1,3 +1,36 @@
+=== 2.5.1 / 2010-04-?
+
+*NOTE*:
+
+RDoc 2.5 did not save method parameters, so you should upgrade your rdoc-data
+gem to a version > 2.5.1.
+
+To have ri data for core and stdlib you'll need to:
+
+  gem install rdoc-data
+
+then run:
+
+  rdoc-data --install
+
+To have ri data for you gems you'll also need to run:
+
+  gem rdoc --all --overwrite
+
+If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
+
+* 1 Minor Enhancement
+  * RDoc::Parser::C now supports the include directive for classes and
+    modules.
+* N Bug Fixes
+  * RDoc::AnyMethod params now get saved in ri data.
+  * ri now displays method arguments correctly.
+  * RDoc::Markup::Parser allows no space between = and header text like rdoc
+    2.4 and earlier.
+  * RDoc::Parser::C's "in" directive now looks in the current directory.
+  * RDoc::Task's rerdoc task no longer deletes the doc directory twice.
+  * rdoc --force-update now works correctly.  Patch by Nobu Nokada
+
 === 2.5 / 2010-03-31
 
 *NOTE*:
@@ -30,14 +63,14 @@ to have ri data for core and stdlib like Array or Kernel or Date.
 
 * 17 Minor Enhancements
   * Source Parsing
-   * RDoc now supports module aliasing via constant assignment.
-   * RDoc now tracks superclasses correctly.  Fixes File < IO for core docs.
-   * RDoc now ignores methods inside methods.
-   * RDoc now ignores Marshal and other binray files.
-   * Removed "Skipping require of dynamic string" warning.
-   * C parser now handles Document-method better.  Bug #27329.
-   * API enhancements for writing parsers like the Ruby parser, see
-     RDoc::Parser::RubyTools
+    * RDoc now supports module aliasing via constant assignment.
+    * RDoc now tracks superclasses correctly.  Fixes File < IO for core docs.
+    * RDoc now ignores methods inside methods.
+    * RDoc now ignores Marshal and other binray files.
+    * Removed "Skipping require of dynamic string" warning.
+    * C parser now handles Document-method better.  Bug #27329.
+    * API enhancements for writing parsers like the Ruby parser, see
+      RDoc::Parser::RubyTools
   * ri
     * Uses pager over less and more for Debian.  Ruby Bug #1171.
     * ri will use the RI_PAGER environment variable to find a pager.

data/Manifest.txt

@@ -105,6 +105,7 @@ test/binary.dat
 test/hidden.zip.txt
 test/test.ja.rdoc
 test/test.ja.txt
+test/test.txt
 test/test_attribute_manager.rb
 test/test_rdoc_any_method.rb
 test/test_rdoc_attr.rb

data/lib/rdoc.rb

@@ -88,7 +88,7 @@ $DEBUG_RDOC = nil
 #
 #   =begin rdoc
 #   Documentation to be processed by RDoc.
-#   
+#
 #   ...
 #   =end
 #
@@ -104,7 +104,7 @@ $DEBUG_RDOC = nil
 #   # FIXME: fails if the birthday falls on February 29th
 #   #++
 #   # The DOB is returned as a Time object.
-#   
+#
 #   def get_dob(person)
 #     # ...
 #   end
@@ -130,7 +130,7 @@ $DEBUG_RDOC = nil
 #
 #   def fred # :yields: index, position
 #     # ...
-#   
+#
 #     yield line, address
 #
 # which will get documented as
@@ -256,12 +256,12 @@ $DEBUG_RDOC = nil
 #   module also will be omitted.  By default, though, modules and
 #   classes within that class of module _will_ be documented.  This is
 #   turned off by adding the +all+ modifier.
-#   
+#
 #     module MyModule # :nodoc:
 #       class Input
 #       end
 #     end
-#     
+#
 #     module OtherModule # :nodoc: all
 #       class Output
 #       end
@@ -295,7 +295,7 @@ $DEBUG_RDOC = nil
 #   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.
@@ -383,7 +383,7 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = '2.5'
+  VERSION = '2.5.1'
 
   ##
   # Name of the dotfile that contains the description of files to be processed

data/lib/rdoc/any_method.rb

@@ -6,7 +6,7 @@ require 'rdoc/tokenstream'
 
 class RDoc::AnyMethod < RDoc::CodeObject
 
-  MARSHAL_VERSION = 0 # :nodoc:
+  MARSHAL_VERSION = 1 # :nodoc:
 
   include Comparable
 
@@ -58,7 +58,7 @@ class RDoc::AnyMethod < RDoc::CodeObject
   ##
   # Parameters for this method
 
-  attr_overridable :params, :param, :parameters, :parameter
+  attr_accessor :params
 
   ##
   # Different ways to call this method
@@ -87,6 +87,7 @@ class RDoc::AnyMethod < RDoc::CodeObject
     @call_seq               = nil
     @dont_rename_initialize = false
     @is_alias_for           = nil
+    @params                 = nil
     @parent_name            = nil
     @singleton              = nil
     @token_stream           = nil
@@ -110,6 +111,19 @@ class RDoc::AnyMethod < RDoc::CodeObject
     @aliases << method
   end
 
+  ##
+  # The call_seq or the param_seq with method name, if there is no call_seq.
+  #
+  # Use this for displaying a method's argument lists.
+
+  def arglists
+    if @call_seq then
+      @call_seq
+    elsif @params then
+      "#{name}#{param_seq}"
+    end
+  end
+
   ##
   # HTML id-friendly method name
 
@@ -151,6 +165,7 @@ class RDoc::AnyMethod < RDoc::CodeObject
       @call_seq,
       @block_params,
       aliases,
+      @params,
     ]
   end
 
@@ -162,7 +177,6 @@ class RDoc::AnyMethod < RDoc::CodeObject
   # * #parent_name
 
   def marshal_load(array)
-    @aliases                = []
     @dont_rename_initialize = nil
     @is_alias_for           = nil
     @token_stream           = nil
@@ -174,6 +188,8 @@ class RDoc::AnyMethod < RDoc::CodeObject
     @comment      = array[5]
     @call_seq     = array[6]
     @block_params = array[7]
+    @aliases      = array[8]
+    @params       = array[9]
 
     @parent_name = if @full_name =~ /#/ then
                      $`
@@ -201,16 +217,16 @@ class RDoc::AnyMethod < RDoc::CodeObject
   # Pretty parameter list for this method
 
   def param_seq
-    params = params.gsub(/\s*\#.*/, '')
+    params = @params.gsub(/\s*\#.*/, '')
     params = params.tr("\n", " ").squeeze(" ")
-    params = "(#{params})" unless p[0] == ?(
+    params = "(#{params})" unless params[0] == ?(
 
-    if block = block_params then # yes, =
+    if @block_params then
       # If this method has explicit block parameters, remove any explicit
       # &block
-      params.sub!(/,?\s*&\w+/)
+      params.sub!(/,?\s*&\w+/, '')
 
-      block.gsub!(/\s*\#.*/, '')
+      block = @block_params.gsub(/\s*\#.*/, '')
       block = block.tr("\n", " ").squeeze(" ")
       if block[0] == ?(
         block.sub!(/^\(/, '').sub!(/\)/, '')

data/lib/rdoc/attr.rb

@@ -56,6 +56,12 @@ class RDoc::Attr < RDoc::CodeObject
   ##
   # Returns nil, for duck typing with RDoc::AnyMethod
 
+  def arglists
+  end
+
+  ##
+  # Returns nil, for duck typing with RDoc::AnyMethod
+
   def block_params
   end
 
@@ -132,6 +138,13 @@ class RDoc::Attr < RDoc::CodeObject
     @parent_name || super
   end
 
+  ##
+  # For duck typing with RDoc::AnyMethod, returns nil
+
+  def params
+    nil
+  end
+
   ##
   # URL path for this attribute
 

data/lib/rdoc/class_module.rb

@@ -145,12 +145,14 @@ class RDoc::ClassModule < RDoc::Context
   # Merges +class_module+ into this ClassModule
 
   def merge class_module
-    if class_module.comment then
+    comment = class_module.comment
+
+    if comment then
       document = parse @comment
 
-      class_module.comment.parts.push(*document.parts)
+      comment.parts.concat document.parts
 
-      @comment = class_module.comment
+      @comment = comment
     end
 
     class_module.each_attribute do |attr|

data/lib/rdoc/code_object.rb

@@ -53,25 +53,6 @@ class RDoc::CodeObject
 
   attr_accessor :viewer
 
-  ##
-  # There's a wee trick we pull. Comment blocks can have directives that
-  # override the stuff we extract during the parse. So, we have a special
-  # class method, attr_overridable, that lets code objects list those
-  # directives. When a comment is assigned, we then extract out any matching
-  # directives and update our object
-
-  def self.attr_overridable(name, *aliases)
-    @overridables ||= {}
-
-    attr_accessor name
-
-    aliases.unshift name
-
-    aliases.each do |directive_name|
-      @overridables[directive_name.to_s] = name
-    end
-  end
-
   ##
   # Creates a new CodeObject that will document itself and its children
 

data/lib/rdoc/generator/darkfish.rb

@@ -1,8 +1,10 @@
-#!ruby
+# -*- mode: ruby; ruby-indent-level: 2; tab-width: 2 -*-
 # vim: noet ts=2 sts=8 sw=2
 
-require 'rubygems'
-gem 'rdoc', '>= 2.4' unless ENV['RDOC_TEST'] or defined?($rdoc_rakefile)
+unless File.exist? File.expand_path('../.svn', __FILE__) then
+  require 'rubygems'
+  gem 'rdoc', '>= 2.4'
+end
 
 require 'pp'
 require 'pathname'
@@ -14,46 +16,46 @@ require 'rdoc/generator/markup'
 $DARKFISH_DRYRUN = false # TODO make me non-global
 
 #
-#  Darkfish RDoc HTML Generator
-#  
-#  $Id: darkfish.rb 52 2009-01-07 02:08:11Z deveiant $
+# Darkfish RDoc HTML Generator
+#
+# $Id: darkfish.rb 52 2009-01-07 02:08:11Z deveiant $
+#
+# == Author/s
+# * Michael Granger (ged@FaerieMUD.org)
+#
+# == Contributors
+# * Mahlon E. Smith (mahlon@martini.nu)
+# * Eric Hodel (drbrain@segment7.net)
+#
+# == License
+#
+# Copyright (c) 2007, 2008, Michael Granger. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the author/s, nor the names of the project's
+#   contributors may be used to endorse or promote products derived from this
+#   software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
-#  == Author/s
-#  * Michael Granger (ged@FaerieMUD.org)
-#  
-#  == Contributors
-#  * Mahlon E. Smith (mahlon@martini.nu)
-#  * Eric Hodel (drbrain@segment7.net)
-#  
-#  == License
-#  
-#  Copyright (c) 2007, 2008, Michael Granger. All rights reserved.
-#  
-#  Redistribution and use in source and binary forms, with or without
-#  modification, are permitted provided that the following conditions are met:
-#  
-#  * Redistributions of source code must retain the above copyright notice,
-#    this list of conditions and the following disclaimer.
-#  
-#  * Redistributions in binary form must reproduce the above copyright notice,
-#    this list of conditions and the following disclaimer in the documentation
-#    and/or other materials provided with the distribution.
-#  
-#  * Neither the name of the author/s, nor the names of the project's
-#    contributors may be used to endorse or promote products derived from this
-#    software without specific prior written permission.
-#  
-#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-#  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
-#  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-#  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-#  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-#  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-#  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-#  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-#  
 class RDoc::Generator::Darkfish
 
 	RDoc::RDoc.add_generator( self )

data/lib/rdoc/generator/template/darkfish/js/darkfish.js

@@ -1,10 +1,10 @@
 /**
- * 
+ *
  * Darkfish Page Functions
  * $Id: darkfish.js 53 2009-01-07 02:52:03Z deveiant $
- * 
+ *
  * Author: Michael Granger <mgranger@laika.com>
- * 
+ *
  */
 
 /* Provide console simulation for firebug-less environments */
@@ -58,7 +58,7 @@ function hookQuickSearch() {
 		var toggle = $(this).parents('.section').find('h3 .search-toggle');
 		// console.debug( "Toggle is: %o", toggle );
 		var qsbox = $(this).parents('form').get( 0 );
-		
+
 		$(this).quicksearch( this, searchElems, {
 			noSearchResultsIndicator: 'no-class-search-results',
 			focusOnLoad: false
@@ -87,7 +87,7 @@ function highlightTarget( anchor ) {
 function highlightLocationTarget() {
 	console.debug( "Location hash: %s", window.location.hash );
 	if ( ! window.location.hash || window.location.hash.length == 0 ) return;
-	
+
 	var anchor = window.location.hash.substring(1);
 	console.debug( "Found anchor: %s; matching %s", anchor, "a[name=" + anchor + "]" );
 

data/lib/rdoc/generator/template/darkfish/js/quicksearch.js

@@ -1,10 +1,10 @@
 /**
- * 
+ *
  * JQuery QuickSearch - Hook up a form field to hide non-matching elements.
  * $Id: quicksearch.js 53 2009-01-07 02:52:03Z deveiant $
- * 
+ *
  * Author: Michael Granger <mgranger@laika.com>
- * 
+ *
  */
 jQuery.fn.quicksearch = function( target, searchElems, options ) {
 	// console.debug( "Quicksearch fn" );
@@ -17,7 +17,7 @@ jQuery.fn.quicksearch = function( target, searchElems, options ) {
 		noSearchResultsIndicator: null
 	};
 	if ( options ) $.extend( settings, options );
-	
+
 	return jQuery(this).each( function() {
 		// console.debug( "Creating a new quicksearch on %o for %o", this, searchElems );
 		new jQuery.quicksearch( this, searchElems, settings );
@@ -56,7 +56,7 @@ jQuery.quicksearch = function( searchBox, searchElems, settings ) {
 					case 8:
 						return true;
 						break;
-					
+
 					// Only allow valid search characters
 					default:
 						return validQSChar( e.charCode );
@@ -88,7 +88,7 @@ jQuery.quicksearch = function( searchBox, searchElems, settings ) {
 		var searchText = searchBox.value;
 		var pat = new RegExp( searchText, "im" );
 		var shownCount = 0;
-	
+
 		if ( settings.noSearchResultsIndicator ) {
 			$('#' + settings.noSearchResultsIndicator).hide();
 		}
@@ -96,7 +96,7 @@ jQuery.quicksearch = function( searchBox, searchElems, settings ) {
 		// All elements start out hidden
 		$(searchElems).each( function(index) {
 			var str = $(this).text();
-			
+
 			if ( pat.test(str) ) {
 				shownCount += 1;
 				$(this).fadeIn();