RubyGems - morph-sdoc - Versions diffs - 0.2.21 - Mend

morph-sdoc 0.2.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (53) hide show

data/.rvmrc +2 -0
data/LICENSE +21 -0
data/README.rdoc +37 -0
data/Rakefile +51 -0
data/VERSION.yml +5 -0
data/bin/sdoc +11 -0
data/bin/sdoc-merge +12 -0
data/lib/rdoc/discover.rb +1 -0
data/lib/sdoc.rb +16 -0
data/lib/sdoc/c_parser_fix.rb +31 -0
data/lib/sdoc/generator/shtml.rb +352 -0
data/lib/sdoc/generator/template/direct/_context.rhtml +172 -0
data/lib/sdoc/generator/template/direct/class.rhtml +40 -0
data/lib/sdoc/generator/template/direct/file.rhtml +30 -0
data/lib/sdoc/generator/template/direct/index.rhtml +14 -0
data/lib/sdoc/generator/template/direct/resources/apple-touch-icon.png +0 -0
data/lib/sdoc/generator/template/direct/resources/css/main.css +278 -0
data/lib/sdoc/generator/template/direct/resources/css/panel.css +383 -0
data/lib/sdoc/generator/template/direct/resources/css/reset.css +53 -0
data/lib/sdoc/generator/template/direct/resources/favicon.ico +0 -0
data/lib/sdoc/generator/template/direct/resources/i/arrows.png +0 -0
data/lib/sdoc/generator/template/direct/resources/i/results_bg.png +0 -0
data/lib/sdoc/generator/template/direct/resources/i/tree_bg.png +0 -0
data/lib/sdoc/generator/template/direct/resources/js/jquery-1.3.2.min.js +19 -0
data/lib/sdoc/generator/template/direct/resources/js/jquery-effect.js +593 -0
data/lib/sdoc/generator/template/direct/resources/js/main.js +22 -0
data/lib/sdoc/generator/template/direct/resources/js/searchdoc.js +628 -0
data/lib/sdoc/generator/template/direct/resources/panel/index.html +71 -0
data/lib/sdoc/generator/template/merge/index.rhtml +14 -0
data/lib/sdoc/generator/template/shtml/_context.rhtml +164 -0
data/lib/sdoc/generator/template/shtml/class.rhtml +46 -0
data/lib/sdoc/generator/template/shtml/file.rhtml +37 -0
data/lib/sdoc/generator/template/shtml/index.rhtml +14 -0
data/lib/sdoc/generator/template/shtml/resources/apple-touch-icon.png +0 -0
data/lib/sdoc/generator/template/shtml/resources/css/main.css +191 -0
data/lib/sdoc/generator/template/shtml/resources/css/panel.css +383 -0
data/lib/sdoc/generator/template/shtml/resources/css/reset.css +53 -0
data/lib/sdoc/generator/template/shtml/resources/favicon.ico +0 -0
data/lib/sdoc/generator/template/shtml/resources/i/arrows.png +0 -0
data/lib/sdoc/generator/template/shtml/resources/i/results_bg.png +0 -0
data/lib/sdoc/generator/template/shtml/resources/i/tree_bg.png +0 -0
data/lib/sdoc/generator/template/shtml/resources/js/jquery-1.3.2.min.js +19 -0
data/lib/sdoc/generator/template/shtml/resources/js/main.js +34 -0
data/lib/sdoc/generator/template/shtml/resources/js/searchdoc.js +628 -0
data/lib/sdoc/generator/template/shtml/resources/panel/index.html +71 -0
data/lib/sdoc/github.rb +61 -0
data/lib/sdoc/helpers.rb +26 -0
data/lib/sdoc/json_backend.rb +15 -0
data/lib/sdoc/merge.rb +217 -0
data/lib/sdoc/options.rb +329 -0
data/lib/sdoc/templatable.rb +58 -0
data/sdoc.gemspec +93 -0
metadata +151 -0

data/lib/sdoc/generator/template/shtml/resources/panel/index.html ADDED Viewed

@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+	<title>layout</title>
+	<link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" charset="utf-8" />
+	<link rel="stylesheet" href="../css/panel.css" type="text/css" media="screen" charset="utf-8" />
+	<script src="search_index.js" type="text/javascript" charset="utf-8"></script>
+	<script src="tree.js" type="text/javascript" charset="utf-8"></script>
+	<script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+	<script src="../js/searchdoc.js" type="text/javascript" charset="utf-8"></script>
+	<script type="text/javascript" charset="utf-8">
+		//<![CDATA[
+	    function placeholder() {
+ 	       if (jQuery.browser.safari) return;
+ 	       $('#search-label').click(function() {
+ 	           $('#search').focus();
+ 	           $('#search-label').hide();
+ 	       });
+ 	       $('#search').focus(function() {
+ 	           $('#search-label').hide();
+            });
+ 	       $('#search').blur(function() {
+ 	           this.value == '' && $('#search-label').show()
+ 	       });
+ 	       $('#search')[0].value == '' && $('#search-label').show();
+	    }
+	   $(function() {
+           placeholder();
+           var panel = new Searchdoc.Panel($('#panel'), search_data, tree, top.frames[1]);
+           $('#search').focus();
+           var s = window.parent.location.search.match(/\?q=([^&]+)/);
+           if (s) {
+               s = decodeURIComponent(s[1]).replace(/\+/g, ' ');
+               if (s.length > 0)
+               {
+                   $('#search').val(s);
+                   panel.search(s, true);
+               }
+           }
+	   })
+		//]]>
+	</script>
+</head>
+<body>
+    <div class="panel panel_tree" id="panel">
+        <div class="header">
+            <div>
+                <label for="search" id="search-label" style="display: none">Search</label>
+                <table>
+                <tr><td>
+                    <input type="Search" placeholder="Search" autosave="searchdoc" results="10" id="search" autocomplete="off"/>
+                </td></tr>
+            </table></div>
+        </div>
+        <div class="tree">
+            <ul>
+            </ul>
+        </div>
+        <div class="result">
+            <ul>
+            </ul>
+        </div>
+    </div>
+</body>
+</html>

data/lib/sdoc/github.rb ADDED Viewed

@@ -0,0 +1,61 @@
+module SDoc::GitHub
+  def github_url(path)
+    unless @github_url_cache.has_key? path
+      @github_url_cache[path] = false
+      file = RDoc::TopLevel.find_file_named(path)
+      if file
+        base_url = repository_url(path)
+        if base_url
+          sha1 = commit_sha1(path)
+          if sha1
+            relative_url = path_relative_to_repository(path)
+            @github_url_cache[path] = "#{base_url}#{sha1}#{relative_url}"
+          end
+        end
+      end
+    end
+    @github_url_cache[path]
+  end
+  protected
+  def have_git?
+    @have_git = system('git --version > /dev/null 2>&1') if @have_git.nil?
+    @have_git
+  end
+  def commit_sha1(path)
+    return false unless have_git?
+    name = File.basename(path)
+    s = Dir.chdir(File.join(basedir, File.dirname(path))) do
+      `git log -1 --pretty=format:"commit %H" #{name}`
+    end
+    m = s.match(/commit\s+(\S+)/)
+    m ? m[1] : false
+  end
+  def repository_url(path)
+    return false unless have_git?
+    s = Dir.chdir(File.join(basedir, File.dirname(path))) do
+      `git config --get remote.origin.url`
+    end
+    m = s.match(%r{github.com[/:](.*)\.git$})
+    m ? "http://github.com/#{m[1]}/blob/" : false
+  end
+  def path_relative_to_repository(path)
+    absolute_path = File.join(basedir, path)
+    root = path_to_git_dir(File.dirname(absolute_path))
+    absolute_path[root.size..absolute_path.size]
+  end
+  def path_to_git_dir(path)
+    while !path.empty? && path != '.'
+      if (File.exists? File.join(path, '.git'))
+        return path
+      end
+      path = File.dirname(path)
+    end
+    ''
+  end
+end

data/lib/sdoc/helpers.rb ADDED Viewed

@@ -0,0 +1,26 @@
+module SDoc::Helpers
+  def each_letter_group(methods, &block)
+    group = {:name => '', :methods => []}
+    methods.sort{ |a, b| a.name <=> b.name }.each do |method|
+      gname = group_name method.name
+      if gname != group[:name]
+        yield group unless group[:methods].size == 0
+        group = {
+          :name => gname,
+          :methods => []
+        }
+      end
+      group[:methods].push(method)
+    end
+    yield group unless group[:methods].size == 0
+  end
+protected
+  def group_name name
+    if match = name.match(/^([a-z])/i)
+      match[1].upcase
+    else
+      '#'
+    end
+  end
+end

data/lib/sdoc/json_backend.rb ADDED Viewed

@@ -0,0 +1,15 @@
+require 'rubygems'
+## undefined method `to_json' for Array :(
+# if Gem.available? "yajl-ruby"
+#   gem "yajl-ruby", ">= 0.7.6"
+#   require "yajl"
+#   warn "yajl"
+# else
+  if Gem.available? "json"
+    gem "json", ">= 1.1.3"
+  else
+    gem "json_pure", ">= 1.1.3"
+  end
+  require "json"
+# end

data/lib/sdoc/merge.rb ADDED Viewed

@@ -0,0 +1,217 @@
+require 'optparse'
+require 'pathname'
+require 'fileutils'
+require 'sdoc/json_backend'
+require 'sdoc/templatable'
+class SDoc::Merge
+  include SDoc::Templatable
+  FLAG_FILE = "created.rid"
+  def initialize()
+    @names = []
+    @urls = []
+    @op_dir = 'doc'
+    @title = ''
+    @directories = []
+    template_dir = RDoc::Generator::SHtml.template_dir('merge')
+		@template_dir = Pathname.new File.expand_path(template_dir)
+  end
+  def merge(options)
+    parse_options options
+		@outputdir = Pathname.new( @op_dir )
+    check_directories
+    setup_output_dir
+    setup_names
+    copy_files
+    copy_docs if @urls.empty?
+    merge_search_index
+    merge_tree
+    generate_index_file
+  end
+  def parse_options(options)
+    opts = OptionParser.new do |opt|
+      opt.banner = "Usage: sdoc-merge [options] directories"
+      opt.on("-n", "--names [NAMES]", "Names of merged repositories. Comma separated") do |v|
+        @names = v.split(',').map{|name| name.strip }
+      end
+      opt.on("-o", "--op [DIRECTORY]", "Set the output directory") do |v|
+        @op_dir = v
+      end
+      opt.on("-t", "--title [TITLE]", "Set the title of merged file") do |v|
+        @title = v
+      end
+      opt.on("-u", "--urls [URLS]", "Paths to merged docs. If you \n" +
+                   "set this files and classes won't be actualy copied to merged build") do |v|
+        @urls = v.split(' ').map{|name| name.strip }
+      end
+    end
+    opts.parse! options
+    @directories = options.dup
+  end
+  def merge_tree
+    tree = []
+    @directories.each_with_index do |dir, i|
+      name = @names[i]
+      url = @urls.empty? ? name : @urls[i]
+      filename = File.join dir, RDoc::Generator::SHtml::TREE_FILE
+      data = open(filename).read.sub(/var tree =\s*/, '')
+      subtree = JSON.parse(data, :max_nesting => 0)
+      item = [
+        name,
+        url + '/' + extract_index_path(dir),
+        '',
+        append_path(subtree, url)
+      ]
+      tree << item
+    end
+    dst = File.join @op_dir, RDoc::Generator::SHtml::TREE_FILE
+    FileUtils.mkdir_p File.dirname(dst)
+    File.open(dst, "w", 0644) do |f|
+      f.write('var tree = '); f.write(tree.to_json(:max_nesting => 0))
+    end
+  end
+  def append_path subtree, path
+    subtree.map do |item|
+      item[1] = path + '/' + item[1] unless item[1].empty?
+      item[3] = append_path item[3], path
+      item
+    end
+  end
+  def merge_search_index
+    items = []
+    @indexes = {}
+    @directories.each_with_index do |dir, i|
+      name = @names[i]
+      url = @urls.empty? ? name : @urls[i]
+      filename = File.join dir, RDoc::Generator::SHtml::SEARCH_INDEX_FILE
+      data = open(filename).read.sub(/var search_data =\s*/, '')
+      subindex = JSON.parse(data, :max_nesting => 0)
+      @indexes[name] = subindex
+      searchIndex = subindex["index"]["searchIndex"]
+      longSearchIndex = subindex["index"]["longSearchIndex"]
+      subindex["index"]["info"].each_with_index do |info, j|
+        info[2] = url + '/' + info[2]
+        info[6] = i
+        items << {
+          :info => info,
+          :searchIndex => searchIndex[j],
+          :longSearchIndex => name + ' ' + longSearchIndex[j]
+        }
+      end
+    end
+    items.sort! do |a, b|
+      # type (class/method/file) or name or doc part or namespace
+      [a[:info][5], a[:info][0], a[:info][6], a[:info][1]] <=> [b[:info][5], b[:info][0], b[:info][6], b[:info][1]]
+    end
+    index = {
+      :searchIndex => items.map{|item| item[:searchIndex]},
+      :longSearchIndex => items.map{|item| item[:longSearchIndex]},
+      :info => items.map{|item| item[:info]}
+    }
+    search_data = {
+      :index => index,
+      :badges => @names
+    }
+    dst = File.join @op_dir, RDoc::Generator::SHtml::SEARCH_INDEX_FILE
+    FileUtils.mkdir_p File.dirname(dst)
+    File.open(dst, "w", 0644) do |f|
+      f.write('var search_data = '); f.write(search_data.to_json(:max_nesting => 0))
+    end
+  end
+  def extract_index_path dir
+    filename = File.join dir, 'index.html'
+    content = File.open(filename) { |f| f.read }
+    match = content.match(/<frame\s+src="([^"]+)"\s+name="docwin"/mi)
+    if match
+      match[1]
+    else
+      ''
+    end
+  end
+  def generate_index_file
+    templatefile = @template_dir + 'index.rhtml'
+    outfile      = @outputdir + 'index.html'
+    url          = @urls.empty? ? @names[0] : @urls[0]
+    index_path   = url + '/' + extract_index_path(@directories[0])
+    render_template templatefile, binding(), outfile
+  end
+  def setup_names
+    unless @names.size > 0
+      @directories.each do |dir|
+        name = File.basename dir
+        name = File.basename File.dirname(dir) if name == 'doc'
+        @names << name
+      end
+    end
+  end
+  def copy_docs
+    @directories.each_with_index do |dir, i|
+      name = @names[i]
+      index_dir = File.dirname(RDoc::Generator::SHtml::TREE_FILE)
+      FileUtils.mkdir_p(File.join(@op_dir, name))
+      Dir.new(dir).each do |item|
+        if File.directory?(File.join(dir, item)) && item != '.' && item != '..' && item != index_dir
+          FileUtils.cp_r File.join(dir, item), File.join(@op_dir, name, item), :preserve => true
+        end
+      end
+    end
+  end
+  def copy_files
+    dir = @directories.first
+    Dir.new(dir).each do |item|
+      if item != '.' && item != '..' && item != RDoc::Generator::SHtml::FILE_DIR && item != RDoc::Generator::SHtml::CLASS_DIR
+        FileUtils.cp_r File.join(dir, item), @op_dir, :preserve => true
+      end
+    end
+  end
+  def setup_output_dir
+    if File.exists? @op_dir
+      error "#{@op_dir} allready exists"
+    end
+    FileUtils.mkdir_p @op_dir
+  end
+  def check_directories
+    @directories.each do |dir|
+      unless File.exists?(File.join(dir, FLAG_FILE)) &&
+      File.exists?(File.join(dir, RDoc::Generator::SHtml::TREE_FILE)) &&
+      File.exists?(File.join(dir, RDoc::Generator::SHtml::SEARCH_INDEX_FILE))
+        error "#{dir} does not seem to be an sdoc directory"
+      end
+    end
+  end
+  ##
+  # Report an error message and exit
+  def error(msg)
+    raise RDoc::Error, msg
+  end
+end

data/lib/sdoc/options.rb ADDED Viewed

@@ -0,0 +1,329 @@
+class RDoc::Options
+  ##
+  # Should source be included?
+  attr_accessor :open_source
+  alias_method :rdoc_initialize, :initialize
+  def initialize # :nodoc:
+    rdoc_initialize
+    @open_source = false
+    @generator = RDoc::Generator::SHtml
+  end
+  ##
+  # Parse command line options. (Copied from RDoc)
+  def parse(argv)
+    opts = OptionParser.new do |opt|
+      opt.program_name = File.basename $0
+      opt.version = RDoc::VERSION
+      opt.release = nil
+      opt.summary_indent = ' ' * 4
+      opt.banner = <<-EOF
+Usage: #{opt.program_name} [options] [names...]
+  Files are parsed, and the information they contain collected, before any
+  output is produced. This allows cross references between all files to be
+  resolved. If a name is a directory, it is traversed. If no names are
+  specified, all Ruby files in the current directory (and subdirectories) are
+  processed.
+  How RDoc generates output depends on the output formatter being used, and on
+  the options you give.
+  - Darkfish creates frameless HTML output by Michael Granger.
+  - ri creates ri data files
+      EOF
+      opt.separator nil
+      opt.separator "Parsing Options:"
+      opt.separator nil
+      opt.on("--all", "-a",
+             "Include all methods (not just public) in",
+             "the output.") do |value|
+        @show_all = value
+      end
+      opt.separator nil
+      opt.on("--exclude=PATTERN", "-x", Regexp,
+             "Do not process files or directories",
+             "matching PATTERN.") do |value|
+        @exclude << value
+      end
+      opt.separator nil
+      opt.on("--extension=NEW=OLD", "-E",
+             "Treat files ending with .new as if they",
+             "ended with .old. Using '-E cgi=rb' will",
+             "cause xxx.cgi to be parsed as a Ruby file.") do |value|
+        new, old = value.split(/=/, 2)
+        unless new and old then
+          raise OptionParser::InvalidArgument, "Invalid parameter to '-E'"
+        end
+        unless RDoc::ParserFactory.alias_extension old, new then
+          raise OptionParser::InvalidArgument, "Unknown extension .#{old} to -E"
+        end
+      end
+      opt.separator nil
+      opt.on("--force-update", "-U",
+             "Forces rdoc to scan all sources even if",
+             "newer than the flag file.") do |value|
+        @force_update = value
+      end
+      opt.separator nil
+      opt.on("--pipe",
+             "Convert RDoc on stdin to HTML") do
+        @pipe = true
+      end
+      opt.separator nil
+      opt.on("--threads=THREADS", Integer,
+             "Number of threads to parse with.") do |threads|
+        @threads = threads
+      end
+      opt.separator nil
+      opt.separator "Generator Options:"
+      opt.separator nil
+      opt.on("--charset=CHARSET", "-c",
+             "Specifies the output HTML character-set.") do |value|
+        @charset = value
+      end
+      opt.separator nil
+      generator_text = @generators.keys.map { |name| "  #{name}" }.sort
+      opt.on("--fmt=FORMAT", "--format=FORMAT", "-f", @generators.keys,
+             "Set the output formatter.  One of:", *generator_text) do |value|
+        @generator_name = value.downcase
+        setup_generator
+      end
+      opt.separator nil
+      opt.on("--include=DIRECTORIES", "-i", Array,
+             "Set (or add to) the list of directories to",
+             "be searched when satisfying :include:",
+             "requests. Can be used more than once.") do |value|
+        @rdoc_include.concat value.map { |dir| dir.strip }
+      end
+      opt.separator nil
+      opt.on("--line-numbers", "-N",
+             "Include line numbers in the source code.") do |value|
+        @include_line_numbers = value
+      end
+      opt.separator nil
+      opt.on("--main=NAME", "-m",
+             "NAME will be the initial page displayed.") do |value|
+        @main_page = value
+      end
+      opt.separator nil
+      opt.on("--output=DIR", "--op", "-o",
+             "Set the output directory.") do |value|
+        @op_dir = value
+      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",
+             "name. When displayed, the '#' is removed",
+             "unless this option is specified.") do |value|
+        @show_hash = value
+      end
+      opt.separator nil
+      opt.on("--open-source", "-s",
+             "Include source code to your documentation") do |value|
+        @open_source = value
+      end
+      opt.separator nil
+      opt.on("--tab-width=WIDTH", "-w", OptionParser::DecimalInteger,
+             "Set the width of tab characters.") do |value|
+        @tab_width = value
+      end
+      opt.separator nil
+      opt.on("--template=NAME", "-T",
+             "Set the template used when generating",
+             "output.") do |value|
+        @template = value
+      end
+      opt.separator nil
+      opt.on("--title=TITLE", "-t",
+             "Set TITLE as the title for HTML output.") do |value|
+        @title = value
+      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",
+             "name of the current file will be",
+             "substituted; if the URL doesn't contain a",
+             "'\%s', the filename will be appended to it.") do |value|
+        @webcvs = value
+      end
+      opt.separator nil
+      opt.separator "Diagram Options:"
+      opt.separator nil
+      image_formats = %w[gif png jpg jpeg]
+      opt.on("--image-format=FORMAT", "-I", image_formats,
+             "Sets output image format for diagrams. Can",
+             "be #{image_formats.join ', '}. If this option",
+             "is omitted, png is used. Requires",
+             "diagrams.") do |value|
+        @image_format = value
+      end
+      opt.separator nil
+      opt.on("--diagram", "-d",
+             "Generate diagrams showing modules and",
+             "classes. You need dot V1.8.6 or later to",
+             "use the --diagram option correctly. Dot is",
+             "available from http://graphviz.org") do |value|
+        check_diagram
+        @diagram = true
+      end
+      opt.separator nil
+      opt.on("--fileboxes", "-F",
+             "Classes are put in boxes which represents",
+             "files, where these classes reside. Classes",
+             "shared between more than one file are",
+             "shown with list of files that are sharing",
+             "them. Silently discarded if --diagram is",
+             "not given.") do |value|
+        @fileboxes = value
+      end
+      opt.separator nil
+      opt.separator "ri Generator Options:"
+      opt.separator nil
+      opt.on("--ri", "-r",
+             "Generate output for use by `ri`. The files",
+             "are stored in the '.rdoc' directory under",
+             "your home directory unless overridden by a",
+             "subsequent --op parameter, so no special",
+             "privileges are needed.") do |value|
+        @generator_name = "ri"
+        @op_dir = RDoc::RI::Paths::HOMEDIR
+        setup_generator
+      end
+      opt.separator nil
+      opt.on("--ri-site", "-R",
+             "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.") do |value|
+        @generator_name = "ri"
+        @op_dir = RDoc::RI::Paths::SITEDIR
+        setup_generator
+      end
+      opt.separator nil
+      opt.on("--merge", "-M",
+             "When creating ri output, merge previously",
+             "processed classes into previously",
+             "documented classes of the same name.") do |value|
+        @merge = value
+      end
+      opt.separator nil
+      opt.separator "Generic Options:"
+      opt.separator nil
+      opt.on("--debug", "-D",
+             "Displays lots on internal stuff.") do |value|
+        $DEBUG_RDOC = value
+      end
+      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.separator 'Deprecated options - these warn when set'
+      opt.separator nil
+      opt.on("--inline-source", "-S") do |value|
+        warn "--inline-source will be removed from RDoc on or after August 2009"
+      end
+      opt.on("--promiscuous", "-p") do |value|
+        warn "--promiscuous will be removed from RDoc on or after August 2009"
+      end
+      opt.separator nil
+    end
+    argv.insert(0, *ENV['RDOCOPT'].split) if ENV['RDOCOPT']
+    opts.parse! argv
+    @files = argv.dup
+    @rdoc_include << "." if @rdoc_include.empty?
+    if @exclude.empty? then
+      @exclude = nil
+    else
+      @exclude = Regexp.new(@exclude.join("|"))
+    end
+    check_files
+    # If no template was specified, use the default template for the output
+    # formatter
+    @template ||= @generator_name
+  rescue OptionParser::InvalidArgument, OptionParser::InvalidOption => e
+    puts opts
+    puts
+    puts e
+    exit 1
+  end
+end