RDoc 3.9.1 will be included with Ruby 1.9.3 provided no show-stopping
bugs are found. Please install RDoc and report any bugs you’ve found.
RDoc produces HTML and command-line documentation for Ruby projects.
RDoc
includes the rdoc
and ri
tools for generating and displaying online
documentation.
See RDoc for a description of RDoc’s markup and basic use.
=== 3.9.1
- Bug fixes
- Fix RDoc::Markup parser for a header followed by a non-text token.
Issue
#56 by Adam Tait - Fix RDoc::Markup::ToHtmlCrossref#gen_url for non-rdoc-ref links.
- Fix bug report URL when rdoc crashes.
- Fix RDoc::Markup parser for a header followed by a non-text token.
=== 3.9
- Minor enhancements
- RDoc::Parser::C now supports :doc: and :nodoc: for class comments
- Added the “rdoc-ref:” link scheme which links to a named reference.
“rdoc-ref:” can resolve references to classes, modules, methods,
files, etc. This can be used to create cross-generator named links
unlike
the “link:” scheme which is dependent upon the exact file name.
Issue #53 by Simon C. - Pulled RDoc::CrossReference out of RDoc::Markup::ToHtmlCrossref.
Cross-references can now be created easily for non-HTML formatters.
- Bug fixes
-
ri []
and other special methods now work properly. Issue #52 by
ddebernardy. -
ri
now has space between class comments from multiple files. - :stopdoc: no longer creates Object references. Issue #55 by Simon
Chiang - :nodoc: works on class aliases now. Issue #51 by Steven G. Harms
- Remove tokenizer restriction on header lengths for verbatim
sections.
Issue #49 by trans
-