Files | Admin


Release Name: 2.4.0

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.

Changes: === 2.3.1 / ?? * N Minor Enhancements * `ri -f html` is now XHTML-happy * Clarified RDoc::Markup link syntax. Bug #23517 by Eric Armstrong. * Number of threads to parse with is now configurable * Darkfish can now use alternate templates from $LOAD_PATH via -T * Removed F95 parser in favor of the rdoc-f95 gem * Moved HTML and XML generators to unmaintained * No gem will be provided as it's too difficult to make them work * Removed options --one-file, --style=, --inline-source, --promiscuous, --op-name * Removed support for --accessor, use regular documentation or the method directive instead. See RDoc::Parser::Ruby * Removed --ri-system as it is unused by Ruby's makefiles * Added method list to index.html * N Bug Fixes * nodoc'd classes no longer appear in the index. Bug #23751 by Clifford Heath. * Fix 1.9 compatibility issues. Bug #23815 by paddor. * Darkfish now respects --charset * RDoc no longer attempts to be lazy when building HTML. This is a workaround. Bug #23893 by Stefano Crocco. * RDoc doesn't crash with def (blah).foo() end * RDoc doesn't crash with #define functions