rdoc 2.3.0 → 2.4.0

data/lib/rdoc/markup/lines.rb

@@ -6,6 +6,10 @@ class RDoc::Markup
   # and an indentation level.
 
   class Line
+    
+    ##
+    # Not really
+
     INFINITY = 9999
 
     LINE_TYPES = [

data/lib/rdoc/markup/preprocess.rb

@@ -7,6 +7,10 @@ require 'rdoc/markup'
 
 class RDoc::Markup::PreProcess
 
+  ##
+  # Creates a new pre-processor for +input_file_name+ that will look for
+  # included files in +include_path+
+
   def initialize(input_file_name, include_path)
     @input_file_name = input_file_name
     @include_path = include_path

data/lib/rdoc/markup/to_flow.rb

@@ -6,9 +6,25 @@ require 'cgi'
 class RDoc::Markup
 
   module Flow
+
+    ##
+    # Paragraph
+
     P = Struct.new(:body)
+
+    ##
+    # Verbatim
+
     VERB = Struct.new(:body)
+
+    ##
+    # Horizontal rule
+
     RULE = Struct.new(:width)
+
+    ##
+    # List
+
     class LIST
       attr_reader :type, :contents
       def initialize(type)
@@ -19,11 +35,21 @@ class RDoc::Markup
         @contents << stuff
       end
     end
+
+    ##
+    # List item
+
     LI = Struct.new(:label, :body)
+
+    ##
+    # Heading
+
     H = Struct.new(:level, :text)
+
   end
 
   class ToFlow < RDoc::Markup::Formatter
+
     LIST_TYPE_TO_HTML = {
       :BULLET     =>  [ "<ul>", "</ul>" ],
       :NUMBER     =>  [ "<ol>", "</ol>" ],
@@ -70,7 +96,7 @@ class RDoc::Markup
     end
 
     ##
-    # Here's the client side of the visitor pattern
+    # :section: Visitor
 
     def start_accepting
       @res = []

data/lib/rdoc/markup/to_html.rb

@@ -116,14 +116,14 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   end
 
   ##
-  # are we currently inside <tt> tags?
+  # are we currently inside tt tags?
 
   def in_tt?
     @in_tt > 0
   end
 
   ##
-  # is +tag+ a <tt> tag?
+  # is +tag+ a tt tag?
 
   def tt?(tag)
     tag.bit == @tt_bit
@@ -158,7 +158,37 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   end
 
   ##
-  # Here's the client side of the visitor pattern
+  # This is a higher speed (if messier) version of wrap
+
+  def wrap(txt, line_len = 76)
+    res = ""
+    sp = 0
+    ep = txt.length
+    while sp < ep
+      # scan back for a space
+      p = sp + line_len - 1
+      if p >= ep
+        p = ep
+      else
+        while p > sp and txt[p] != ?\s
+          p -= 1
+        end
+        if p <= sp
+          p = sp + line_len
+          while p < ep and txt[p] != ?\s
+            p += 1
+          end
+        end
+      end
+      res << txt[sp...p] << "\n"
+      sp = p
+      sp += 1 while sp < ep and txt[sp] == ?\s
+    end
+    res
+  end
+
+  ##
+  # :section: Visitor
 
   def start_accepting
     @res = ""
@@ -219,36 +249,6 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
     @res << convert_heading(fragment.head_level, am.flow(fragment.txt))
   end
 
-  ##
-  # This is a higher speed (if messier) version of wrap
-
-  def wrap(txt, line_len = 76)
-    res = ""
-    sp = 0
-    ep = txt.length
-    while sp < ep
-      # scan back for a space
-      p = sp + line_len - 1
-      if p >= ep
-        p = ep
-      else
-        while p > sp and txt[p] != ?\s
-          p -= 1
-        end
-        if p <= sp
-          p = sp + line_len
-          while p < ep and txt[p] != ?\s
-            p += 1
-          end
-        end
-      end
-      res << txt[sp...p] << "\n"
-      sp = p
-      sp += 1 while sp < ep and txt[sp] == ?\s
-    end
-    res
-  end
-
   private
 
   def on_tags(res, item)

data/lib/rdoc/markup/to_html_crossref.rb

@@ -1,9 +1,8 @@
 require 'rdoc/markup/to_html'
 
 ##
-# Subclass of the RDoc::Markup::ToHtml class that supports looking up words in
-# the AllReferences list. Those that are found (like AllReferences in this
-# comment) will be hyperlinked
+# Subclass of the RDoc::Markup::ToHtml class that supports looking up words
+# from a context.  Those that are found will be hyperlinked.
 
 class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
 
@@ -14,12 +13,6 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   # 2) There can be a '::' in front of class names to reference from the
   #    top-level namespace.
   # 3) The method can be followed by parenthesis which may
-  #
-  # NOTE: In order to support Fortran 95 properly, the [A-Z] below
-  # should be changed to [A-Za-z].  This slows down rdoc significantly,
-  # however, and the Fortran 95 support is broken in any case due to
-  # the return in handle_special_CROSSREF if the token consists
-  # entirely of lowercase letters.
 
   CLASS_REGEXP_STR = '\\\\?((?:\:{2})?[A-Z]\w*(?:\:\:\w+)*)'
   METHOD_REGEXP_STR = '(\w+[!?=]?)(?:\([\.\w+\*\/\+\-\=\<\>]*\))?'
@@ -64,7 +57,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
                       )/x
 
   ##
-  # RDoc::Generator::Context for generating references
+  # RDoc::CodeObject for generating references
 
   attr_accessor :context
 
@@ -110,7 +103,6 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
       lookup = name
     end
 
-
     # Find class, module, or method in class or module.
     #
     # Do not, however, use an if/elsif/else chain to do so.  Instead, test
@@ -143,3 +135,4 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   end
 
 end
+

data/lib/rdoc/markup/to_latex.rb

@@ -87,7 +87,37 @@ class RDoc::Markup::ToLaTeX < RDoc::Markup::Formatter
   end
 
   ##
-  # Here's the client side of the visitor pattern
+  # This is a higher speed (if messier) version of wrap
+
+  def wrap(txt, line_len = 76)
+    res = ""
+    sp = 0
+    ep = txt.length
+    while sp < ep
+      # scan back for a space
+      p = sp + line_len - 1
+      if p >= ep
+        p = ep
+      else
+        while p > sp and txt[p] != ?\s
+          p -= 1
+        end
+        if p <= sp
+          p = sp + line_len
+          while p < ep and txt[p] != ?\s
+            p += 1
+          end
+        end
+      end
+      res << txt[sp...p] << "\n"
+      sp = p
+      sp += 1 while sp < ep and txt[sp] == ?\s
+    end
+    res
+  end
+
+  ##
+  # :section: Visitor
 
   def start_accepting
     @res = ""
@@ -144,36 +174,6 @@ class RDoc::Markup::ToLaTeX < RDoc::Markup::Formatter
     @res << convert_heading(fragment.head_level, am.flow(fragment.txt))
   end
 
-  ##
-  # This is a higher speed (if messier) version of wrap
-
-  def wrap(txt, line_len = 76)
-    res = ""
-    sp = 0
-    ep = txt.length
-    while sp < ep
-      # scan back for a space
-      p = sp + line_len - 1
-      if p >= ep
-        p = ep
-      else
-        while p > sp and txt[p] != ?\s
-          p -= 1
-        end
-        if p <= sp
-          p = sp + line_len
-          while p < ep and txt[p] != ?\s
-            p += 1
-          end
-        end
-      end
-      res << txt[sp...p] << "\n"
-      sp = p
-      sp += 1 while sp < ep and txt[sp] == ?\s
-    end
-    res
-  end
-
   private
 
   def on_tags(res, item)

data/lib/rdoc/markup/to_test.rb

@@ -6,6 +6,9 @@ require 'rdoc/markup/formatter'
 
 class RDoc::Markup::ToTest < RDoc::Markup::Formatter
 
+  ##
+  # :section: Visitor
+
   def start_accepting
     @res = []
   end

data/lib/rdoc/markup/to_texinfo.rb

@@ -9,9 +9,25 @@ require 'rdoc/markup/formatter'
 # Convert SimpleMarkup to basic TexInfo format
 #
 # TODO: WTF is AttributeManager for?
-#
+
 class RDoc::Markup::ToTexInfo < RDoc::Markup::Formatter
 
+  def format(text)
+    text.txt.
+      gsub(/@/, "@@").
+      gsub(/\{/, "@{").
+      gsub(/\}/, "@}").
+      # gsub(/,/, "@,"). # technically only required in cross-refs
+      gsub(/\+([\w]+)\+/, "@code{\\1}").
+      gsub(/\<tt\>([^<]+)\<\/tt\>/, "@code{\\1}").
+      gsub(/\*([\w]+)\*/, "@strong{\\1}").
+      gsub(/\<b\>([^<]+)\<\/b\>/, "@strong{\\1}").
+      gsub(/_([\w]+)_/, "@emph{\\1}").
+      gsub(/\<em\>([^<]+)\<\/em\>/, "@emph{\\1}")
+  end
+
+  # :section: Visitor
+
   def start_accepting
     @text = []
   end
@@ -53,17 +69,5 @@ class RDoc::Markup::ToTexInfo < RDoc::Markup::Formatter
     @text << '-----'
   end
 
-  def format(text)
-    text.txt.
-      gsub(/@/, "@@").
-      gsub(/\{/, "@{").
-      gsub(/\}/, "@}").
-      # gsub(/,/, "@,"). # technically only required in cross-refs
-      gsub(/\+([\w]+)\+/, "@code{\\1}").
-      gsub(/\<tt\>([^<]+)\<\/tt\>/, "@code{\\1}").
-      gsub(/\*([\w]+)\*/, "@strong{\\1}").
-      gsub(/\<b\>([^<]+)\<\/b\>/, "@strong{\\1}").
-      gsub(/_([\w]+)_/, "@emph{\\1}").
-      gsub(/\<em\>([^<]+)\<\/em\>/, "@emph{\\1}")
-  end
 end
+

data/lib/rdoc/meta_method.rb

@@ -0,0 +1,8 @@
+require 'rdoc/any_method'
+
+##
+# MetaMethod represents a meta-programmed method
+
+class RDoc::MetaMethod < RDoc::AnyMethod
+end
+

data/lib/rdoc/normal_class.rb

@@ -0,0 +1,18 @@
+require 'rdoc/class_module'
+
+##
+# A normal class, neither singleton nor anonymous
+
+class RDoc::NormalClass < RDoc::ClassModule
+
+  def inspect # :nodoc:
+    superclass = @superclass ? " < #{@superclass}" : nil
+    "<%s:0x%x class %s%s includes: %p attributes: %p methods: %p aliases: %p>" % [
+      self.class, object_id,
+      full_name, superclass, @includes, @attributes, @method_list, @aliases
+    ]
+  end
+
+end
+
+

data/lib/rdoc/normal_module.rb

@@ -0,0 +1,34 @@
+require 'rdoc/class_module'
+
+##
+# A normal module, like NormalClass
+
+class RDoc::NormalModule < RDoc::ClassModule
+
+  ##
+  # Appends +comment+ to the current comment, but separated by a rule
+
+  def comment=(comment)
+    return if comment.empty?
+    comment = @comment << "\n# ---\n" << comment unless @comment.empty?
+
+    super
+  end
+
+  def inspect # :nodoc:
+    "#<%s:0x%x module %s includes: %p attributes: %p methods: %p aliases: %p>" % [
+      self.class, object_id,
+      full_name, @includes, @attributes, @method_list, @aliases
+    ]
+  end
+
+  ##
+  # This is a module, returns true
+
+  def module?
+    true
+  end
+
+end
+
+

data/lib/rdoc/options.rb

@@ -7,21 +7,11 @@ require 'rdoc/ri/paths'
 
 class RDoc::Options
 
-  ##
-  # Should the output be placed into a single file?
-
-  attr_reader :all_one_file
-
   ##
   # Character-set
 
   attr_reader :charset
 
-  ##
-  # URL of stylesheet
-
-  attr_reader :css
-
   ##
   # Should diagrams be drawn?
 
@@ -32,16 +22,6 @@ class RDoc::Options
 
   attr_accessor :exclude
 
-  ##
-  # Additional attr_... style method flags
-
-  attr_reader :extra_accessor_flags
-
-  ##
-  # Pattern for additional attr_... style methods
-
-  attr_accessor :extra_accessors
-
   ##
   # Should we draw fileboxes in diagrams?
 
@@ -77,11 +57,6 @@ class RDoc::Options
 
   attr_reader :include_line_numbers
 
-  ##
-  # Should source code be included inline, or displayed in a popup
-
-  attr_accessor :inline_source
-
   ##
   # Name of the file, class or module to display in the initial index page (if
   # not specified the first file we encounter is used)
@@ -98,16 +73,6 @@ class RDoc::Options
 
   attr_accessor :op_dir
 
-  ##
-  # The name to use for the output
-
-  attr_accessor :op_name
-
-  ##
-  # Are we promiscuous about showing module contents across multiple files?
-
-  attr_reader :promiscuous
-
   ##
   # Array of directories to search for files to satisfy an :include:
 
@@ -134,11 +99,9 @@ class RDoc::Options
   attr_reader :template
 
   ##
-  # Template class for file generation
-  #--
-  # HACK around dependencies in lib/rdoc/generator/html.rb
+  # Number of threads to parse with
 
-  attr_accessor :template_class # :nodoc:
+  attr_accessor :threads
 
   ##
   # Documentation title
@@ -157,8 +120,7 @@ class RDoc::Options
 
   def initialize # :nodoc:
     require 'rdoc/rdoc'
-    @op_dir = "doc"
-    @op_name = nil
+    @op_dir = 'doc'
     @show_all = false
     @main_page = nil
     @merge = false
@@ -168,21 +130,20 @@ class RDoc::Options
     @rdoc_include = []
     @title = nil
     @template = nil
-    @template_class = nil
+    @threads = if RUBY_PLATFORM == 'java' then
+                 Java::java::lang::Runtime.getRuntime.availableProcessors * 2
+               else
+                 2
+               end
     @diagram = false
     @fileboxes = false
     @show_hash = false
     @image_format = 'png'
-    @inline_source = false
-    @all_one_file = false
     @tab_width = 8
     @include_line_numbers = false
-    @extra_accessor_flags = {}
-    @promiscuous = false
-    @force_update = false
+    @force_update = true
     @verbosity = 1
 
-    @css = nil
     @webcvs = nil
 
     @charset = 'utf-8'
@@ -192,8 +153,6 @@ class RDoc::Options
   # Parse command line options.
 
   def parse(argv)
-    accessors = []
-
     opts = OptionParser.new do |opt|
       opt.program_name = File.basename $0
       opt.version = RDoc::VERSION
@@ -211,47 +170,15 @@ Usage: #{opt.program_name} [options] [names...]
   How RDoc generates output depends on the output formatter being used, and on
   the options you give.
 
-  - Darkfish is an improved, frameless HTML output by Michael Granger.
-
-  - HTML output is normally produced into a number of separate files
-    (one per class, module, and file, along with various indices).
-    These files will appear in the directory given by the --op
-    option (doc/ by default).
+  - Darkfish creates frameless HTML output by Michael Granger.
 
-  - XML output by default is written to standard output. If a
-    --opname option is given, the output will instead be written
-    to a file with that name in the output directory.
-
-  - .chm files (Windows help files) are written in the --op directory.
-    If an --opname parameter is present, that name is used, otherwise
-    the file will be called rdoc.chm.
+  - ri creates ri data files
       EOF
 
       opt.separator nil
       opt.separator "Options:"
       opt.separator nil
 
-      opt.on("--accessor=ACCESSORS", "-A", Array,
-             "A comma separated list of additional class",
-             "methods that should be treated like",
-             "'attr_reader' and friends.",
-             " ",
-             "Option may be repeated.",
-             " ",
-             "Each accessorname may have '=text'",
-             "appended, in which case that text appears",
-             "where the r/w/rw appears for normal.",
-             "accessors") do |value|
-        value.each do |accessor|
-          if accessor =~ /^(\w+)(=(.*))?$/
-            accessors << $1
-            @extra_accessor_flags[$1] = $3
-          end
-        end
-      end
-
-      opt.separator nil
-
       opt.on("--all", "-a",
              "Include all methods (not just public) in",
              "the output.") do |value|
@@ -360,14 +287,6 @@ Usage: #{opt.program_name} [options] [names...]
 
       opt.separator nil
 
-      opt.on("--inline-source", "-S",
-             "Show method source code inline, rather than",
-             "via a popup link.") do |value|
-        @inline_source = value
-      end
-
-      opt.separator nil
-
       opt.on("--line-numbers", "-N",
              "Include line numbers in the source code.") do |value|
         @include_line_numbers = value
@@ -391,52 +310,18 @@ Usage: #{opt.program_name} [options] [names...]
 
       opt.separator nil
 
-      opt.on("--one-file", "-1",
-             "Put all the output into a single file.") do |value|
-        @all_one_file = value
-        @inline_source = value if value
-        @template = 'one_page_html'
-      end
-
-      opt.separator nil
-
-      opt.on("--op=DIR", "-o",
+      opt.on("--output=DIR", "--op", "-o",
              "Set the output directory.") do |value|
         @op_dir = value
       end
 
       opt.separator nil
 
-      opt.on("--opname=NAME", "-n",
-             "Set the NAME of the output. Has no effect",
-             "for HTML.") do |value|
-        @op_name = value
-      end
-
-      opt.separator nil
-
-      opt.on("--promiscuous", "-p",
-             "When documenting a file that contains a",
-             "module or class also defined in other",
-             "files, show all stuff for that module or",
-             "class in each files page. By default, only",
-             "show stuff defined in that particular file.") do |value|
-        @promiscuous = value
-      end
-
-      opt.separator nil
-
       opt.on("--quiet", "-q",
              "Don't show progress as we parse.") do |value|
         @verbosity = 0
       end
 
-      opt.on("--verbose", "-v",
-             "Display extra progress as we parse.") do |value|
-        @verbosity = 2
-      end
-
-
       opt.separator nil
 
       opt.on("--ri", "-r",
@@ -464,20 +349,6 @@ Usage: #{opt.program_name} [options] [names...]
 
       opt.separator nil
 
-      opt.on("--ri-system", "-Y",
-             "Generate output for use by `ri`. The files",
-             "are stored in a site-wide directory,",
-             "making them accessible to others, so",
-             "special privileges are needed.  This",
-             "option is intended to be used during Ruby",
-             "installation.") do |value|
-        @generator_name = "ri"
-        @op_dir = RDoc::RI::Paths::SYSDIR
-        setup_generator
-      end
-
-      opt.separator nil
-
       opt.on("--show-hash", "-H",
              "A name of the form #name in a comment is a",
              "possible hyperlink to an instance method",
@@ -488,13 +359,6 @@ Usage: #{opt.program_name} [options] [names...]
 
       opt.separator nil
 
-      opt.on("--style=URL", "-s",
-             "Specifies the URL of a separate stylesheet.") do |value|
-        @css = value
-      end
-
-      opt.separator nil
-
       opt.on("--tab-width=WIDTH", "-w", OptionParser::DecimalInteger,
              "Set the width of tab characters.") do |value|
         @tab_width = value
@@ -510,6 +374,13 @@ Usage: #{opt.program_name} [options] [names...]
 
       opt.separator nil
 
+      opt.on("--threads=THREADS", Integer,
+             "Number of threads to parse with.") do |threads|
+        @threads = threads
+      end
+
+      opt.separator nil
+
       opt.on("--title=TITLE", "-t",
              "Set TITLE as the title for HTML output.") do |value|
         @title = value
@@ -517,6 +388,13 @@ Usage: #{opt.program_name} [options] [names...]
 
       opt.separator nil
 
+      opt.on("--verbose", "-v",
+             "Display extra progress as we parse.") do |value|
+        @verbosity = 2
+      end
+
+      opt.separator nil
+
       opt.on("--webcvs=URL", "-W",
              "Specify a URL for linking to a web frontend",
              "to CVS. If the URL contains a '\%s', the",
@@ -548,12 +426,6 @@ Usage: #{opt.program_name} [options] [names...]
 
     @template ||= @generator_name
 
-    # Generate a regexp from the accessors
-    unless accessors.empty? then
-      re = '^(' + accessors.map { |a| Regexp.quote a }.join('|') + ')$'
-      @extra_accessors = Regexp.new re
-    end
-
   rescue OptionParser::InvalidArgument, OptionParser::InvalidOption => e
     puts opts
     puts
@@ -591,11 +463,6 @@ Usage: #{opt.program_name} [options] [names...]
     unless @generator then
       raise OptionParser::InvalidArgument, "Invalid output formatter"
     end
-
-    if @generator_name == "xml" then
-      @all_one_file = true
-      @inline_source = true
-    end
   end
 
   # Check that the right version of 'dot' is available.  Unfortunately this