svn/view/gendoc.rb

#!/usr/bin/ruby
#
# gendoc.rb: A short program to generate class specifications of Edmaru.
#
# Copyright (C) 2007 Takashi Nakamoto
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 USA.
#

args = Array.new

# Set UTF-8 as HTML character sets.
args.push "--charset"
args.push "utf-8"

# Include line numbers in source codes
args.push "--line-numbers"

# Generate diagrams showing modules and classes.
if ARGV.include?("-d")
  args.push "--diagram"
end

# Png format will be used as image format for diagrams.
if args.include?("--diagram")
  args.push "--image-format"
  args.push "png"
end

# Set "doc" as the output directory
args.push "--op"
args.push "doc/rdoc"

# Update all documentation forcibly.
args.push "--force-update"

# Title of generated documents.
args.push "--title"
args.push "'Edmaru API reference'"

# Link to WebCVS.
args.push "--webcvs"
args.push "http://svn.sourceforge.jp/cgi-bin/viewcvs.cgi/%s?root=edmaru&view=log"

# Use the original template.
args.push "--template"
args.push "./rdoc_template"

# Don't generate the documents of unrelated files to Edmaru.
#args.push "--exclude"
#args.push "rdoc"

# Set README as the top page of API reference.
args.push "--main"
args.push "README"

# Files parsed by RDoc.
require "find"
search_dir = "./"
Find.find(search_dir){ |f|
  f = f[(search_dir.size)..-1]
  case f
  when /\.rb\Z/, "AUTHORS", "COPYING", "ChangeLog", "README",
    /\Adoc\/[A-Z]*\Z/
    args.push f
  end
}

# main procedure to generate class specification
require "rdoc/rdoc"
begin
  r = RDoc::RDoc.new
  r.document(args)
rescue RDoc::RDocError => e
  $stderr.puts e.message
  exit(1)
end