ruby-****@sourc*****
ruby-****@sourc*****
2004年 1月 22日 (木) 03:47:37 JST
-------------------------
REMOTE_ADDR = 217.117.55.140
REMOTE_HOST =
URL = http://ruby-gnome2.sourceforge.jp/?using_extdoc
-------------------------
= Using Extdoc.rb
This document introduces Extdoc, the documentation system used to generate API reference from source files (parsing C comments).
Extdoc is able to produce Text/ASCII, Docbook/XHTML and RD+ documents.
It is currently used in several Ruby libraries, such as Ruby/GStreamer, Ruby/Libgda, Ruby/Libburn, etc...
== Getting started
=== Sources
Sources can be downloaded from anonymous CVS, using the following instructions:
$ cvs -d:pserver:anony****@cvs*****:/cvsroot/ruby-gnome2 login
$ cvs -z3 -d:pserver:anony****@cvs*****:/cvsroot/ruby-gnome2 co tools/extdoc
(when prompted for a password for anonymous, simply press the Enter key).
You can also browse the sources via the ((<web interface|URL:http://cvs.sourceforge.net/viewcvs.py/ruby-gnome2/tools/extdoc/>)).
=== Install
Once you have downloaded the sources, use the following commands in order to setup and install Extdoc:
$ ruby install.rb config
$ ruby install.rb setup
$ su
$ ruby install.rb install
Check that Extdoc is correctly installed:
$ extdoc -V
0.2.0
== Specs
TODO