gem.sh

Name

rdoc

Version

2.5.8

Platform

ruby

Authors

Eric Hodel
Dave Thomas
Phil Hagelberg
Tony Strauss

Bindir

bin

Cert chain

Date

2010-04-27 00:00:00 UTC

Dependencies

rubyforge (>= 2.0.3, development)
gemcutter (>= 0.5.0, development)
minitest (~> 1.3, development)
hoe (>= 2.5.0, development)

Description

RDoc is an application that produces documentation for one or more Ruby source files. RDoc includes the +rdoc+ and +ri+ tools for generating and displaying online documentation. At this point in time, RDoc 2.x is a work in progress and may incur further API changes beyond what has been made to RDoc 1.0.1. Command-line tools are largely unaffected, but internal APIs may shift rapidly. See RDoc for a description of RDoc's markup and basic use.

Email

drbrain@segment7.net

technomancy@gmail.com
tony.strauss@designingpatterns.com

Executables

rdoc
ri

Extra rdoc files

History.txt
LICENSE.txt
Manifest.txt
README.txt
RI.txt
Rakefile

Files

.autotest
.document
History.txt
LICENSE.txt
Manifest.txt
README.txt
RI.txt
Rakefile
bin/rdoc
bin/ri
lib/rdoc.rb
lib/rdoc/alias.rb
lib/rdoc/anon_class.rb
lib/rdoc/any_method.rb
lib/rdoc/attr.rb
lib/rdoc/class_module.rb
lib/rdoc/code_object.rb
lib/rdoc/code_objects.rb
lib/rdoc/constant.rb
lib/rdoc/context.rb
lib/rdoc/gauntlet.rb
lib/rdoc/generator.rb
lib/rdoc/generator/darkfish.rb
lib/rdoc/generator/markup.rb
lib/rdoc/generator/ri.rb
lib/rdoc/generator/template/darkfish/.document
lib/rdoc/generator/template/darkfish/classpage.rhtml
lib/rdoc/generator/template/darkfish/filepage.rhtml
lib/rdoc/generator/template/darkfish/images/brick.png
lib/rdoc/generator/template/darkfish/images/brick_link.png
lib/rdoc/generator/template/darkfish/images/bug.png
lib/rdoc/generator/template/darkfish/images/bullet_black.png
lib/rdoc/generator/template/darkfish/images/bullet_toggle_minus.png
lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png
lib/rdoc/generator/template/darkfish/images/date.png
lib/rdoc/generator/template/darkfish/images/find.png
lib/rdoc/generator/template/darkfish/images/loadingAnimation.gif
lib/rdoc/generator/template/darkfish/images/macFFBgHack.png
lib/rdoc/generator/template/darkfish/images/package.png
lib/rdoc/generator/template/darkfish/images/page_green.png
lib/rdoc/generator/template/darkfish/images/page_white_text.png
lib/rdoc/generator/template/darkfish/images/page_white_width.png
lib/rdoc/generator/template/darkfish/images/plugin.png
lib/rdoc/generator/template/darkfish/images/ruby.png
lib/rdoc/generator/template/darkfish/images/tag_green.png
lib/rdoc/generator/template/darkfish/images/wrench.png
lib/rdoc/generator/template/darkfish/images/wrench_orange.png
lib/rdoc/generator/template/darkfish/images/zoom.png
lib/rdoc/generator/template/darkfish/index.rhtml
lib/rdoc/generator/template/darkfish/js/darkfish.js
lib/rdoc/generator/template/darkfish/js/jquery.js
lib/rdoc/generator/template/darkfish/js/quicksearch.js
lib/rdoc/generator/template/darkfish/js/thickbox-compressed.js
lib/rdoc/generator/template/darkfish/rdoc.css
lib/rdoc/ghost_method.rb
lib/rdoc/include.rb
lib/rdoc/known_classes.rb
lib/rdoc/markup.rb
lib/rdoc/markup/attribute_manager.rb
lib/rdoc/markup/blank_line.rb
lib/rdoc/markup/document.rb
lib/rdoc/markup/formatter.rb
lib/rdoc/markup/formatter_test_case.rb
lib/rdoc/markup/heading.rb
lib/rdoc/markup/inline.rb
lib/rdoc/markup/list.rb
lib/rdoc/markup/list_item.rb
lib/rdoc/markup/paragraph.rb
lib/rdoc/markup/parser.rb
lib/rdoc/markup/preprocess.rb
lib/rdoc/markup/raw.rb
lib/rdoc/markup/rule.rb
lib/rdoc/markup/to_ansi.rb
lib/rdoc/markup/to_bs.rb
lib/rdoc/markup/to_html.rb
lib/rdoc/markup/to_html_crossref.rb
lib/rdoc/markup/to_rdoc.rb
lib/rdoc/markup/to_test.rb
lib/rdoc/markup/verbatim.rb
lib/rdoc/meta_method.rb
lib/rdoc/normal_class.rb
lib/rdoc/normal_module.rb
lib/rdoc/options.rb
lib/rdoc/parser.rb
lib/rdoc/parser/c.rb
lib/rdoc/parser/perl.rb
lib/rdoc/parser/ruby.rb
lib/rdoc/parser/ruby_tools.rb
lib/rdoc/parser/simple.rb
lib/rdoc/rdoc.rb
lib/rdoc/require.rb
lib/rdoc/ri.rb
lib/rdoc/ri/driver.rb
lib/rdoc/ri/formatter.rb
lib/rdoc/ri/paths.rb
lib/rdoc/ri/store.rb
lib/rdoc/ruby_lex.rb
lib/rdoc/ruby_token.rb
lib/rdoc/single_class.rb
lib/rdoc/stats.rb
lib/rdoc/task.rb
lib/rdoc/text.rb
lib/rdoc/tokenstream.rb
lib/rdoc/top_level.rb
test/README
test/binary.dat
test/hidden.zip.txt
test/test.ja.rdoc
test/test.ja.txt
test/test.txt
test/test_attribute_manager.rb
test/test_rdoc_any_method.rb
test/test_rdoc_attr.rb
test/test_rdoc_class_module.rb
test/test_rdoc_code_object.rb
test/test_rdoc_constant.rb
test/test_rdoc_context.rb
test/test_rdoc_generator_ri.rb
test/test_rdoc_include.rb
test/test_rdoc_markup.rb
test/test_rdoc_markup_attribute_manager.rb
test/test_rdoc_markup_document.rb
test/test_rdoc_markup_paragraph.rb
test/test_rdoc_markup_parser.rb
test/test_rdoc_markup_pre_process.rb
test/test_rdoc_markup_raw.rb
test/test_rdoc_markup_to_ansi.rb
test/test_rdoc_markup_to_bs.rb
test/test_rdoc_markup_to_html.rb
test/test_rdoc_markup_to_html_crossref.rb
test/test_rdoc_markup_to_rdoc.rb
test/test_rdoc_normal_class.rb
test/test_rdoc_normal_module.rb
test/test_rdoc_options.rb
test/test_rdoc_parser.rb
test/test_rdoc_parser_c.rb
test/test_rdoc_parser_perl.rb
test/test_rdoc_parser_ruby.rb
test/test_rdoc_parser_simple.rb
test/test_rdoc_rdoc.rb
test/test_rdoc_require.rb
test/test_rdoc_ri_driver.rb
test/test_rdoc_ri_paths.rb
test/test_rdoc_ri_store.rb
test/test_rdoc_task.rb
test/test_rdoc_text.rb
test/test_rdoc_top_level.rb
test/xref_data.rb
test/xref_test_case.rb

Has rdoc

true

Homepage

http://rdoc.rubyforge.org

Post install message

RDoc 2.5 did not save method parameters, so you should upgrade your rdoc-data gem to a version >= 2.5.3. To have ri data for core and stdlib you'll need to: gem install rdoc-data then run: rdoc-data --install To have ri data for you gems you'll also need to run: gem rdoc --all --overwrite If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.

Rdoc options

--main
README.txt

Require paths

lib

Required ruby version

>= 0

Required rubygems version

>= 1.3

Rubyforge project

rdoc

Rubygems version

1.3.7.pre.1

Specification version

3

Summary

RDoc is an application that produces documentation for one or more Ruby source files

Test files

test/test_attribute_manager.rb
test/test_rdoc_any_method.rb
test/test_rdoc_attr.rb
test/test_rdoc_class_module.rb
test/test_rdoc_code_object.rb
test/test_rdoc_constant.rb
test/test_rdoc_context.rb
test/test_rdoc_generator_ri.rb
test/test_rdoc_include.rb
test/test_rdoc_markup.rb
test/test_rdoc_markup_attribute_manager.rb
test/test_rdoc_markup_document.rb
test/test_rdoc_markup_paragraph.rb
test/test_rdoc_markup_parser.rb
test/test_rdoc_markup_pre_process.rb
test/test_rdoc_markup_raw.rb
test/test_rdoc_markup_to_ansi.rb
test/test_rdoc_markup_to_bs.rb
test/test_rdoc_markup_to_html.rb
test/test_rdoc_markup_to_html_crossref.rb
test/test_rdoc_markup_to_rdoc.rb
test/test_rdoc_normal_class.rb
test/test_rdoc_normal_module.rb
test/test_rdoc_options.rb
test/test_rdoc_parser.rb
test/test_rdoc_parser_c.rb
test/test_rdoc_parser_perl.rb
test/test_rdoc_parser_ruby.rb
test/test_rdoc_parser_simple.rb
test/test_rdoc_rdoc.rb
test/test_rdoc_require.rb
test/test_rdoc_ri_driver.rb
test/test_rdoc_ri_paths.rb
test/test_rdoc_ri_store.rb
test/test_rdoc_task.rb
test/test_rdoc_text.rb
test/test_rdoc_top_level.rb

Original platform

ruby

New platform

ruby

Modules

Classes

Metadata

Top-Level Modules

Top-Level Classes