rdoc

RDOC - Ruby Documentation System

http://blog.enjoyrails.com/2008/07/14/ruby187-and-rails-210-api/
http://rdoc.sourceforge.net/doc/index.html

rdoc是生成ruby代码api文档的工具，跟javadoc的功能类似，在命令行中输入rdoc，它能够遍历当前目录的ruby源代码文件（以.rb 或.rbw为扩展名）进行解析然后生成规范的ruby api文档。可以用rdoc --help来查看具体的命令行参数。rdoc对注释内的特殊标签进行解析并将输出格式化。

cd 项目所在文件夹
rdoc --op ~/spider  --fmt html --exclude .*generator.* --exclude .*test.* --exclude public --exclude log --exclude vendor --exclude script -c utf-8       

--op           where to put rdoc
--fmt          rdoc format:html chm ri xml
--exclude    ignore file or directory matching  the specified pattern
-c               encoding

gem environment
cd /usr/lib/ruby/gems/1.8/gems

rdoc --op ~/rdoc-3.0.0.rc2 --fmt html --charset utf-8 --inline-source --exclude .*generator.* --exclude .*test.* --include actionmailer-3.0.0.rc2 actionpack-3.0.0.rc2 activemodel-3.0.0.rc2 activerecord-3.0.0.rc2 activeresource-3.0.0.rc2 activesupport-3.0.0.rc2 rails-3.0.0.rc2 railties-3.0.0.rc2