- home: GitHub - rdoc/rdoc: RDoc produces HTML and online documentation for Ruby projects. RDoc includes the rdoc and ri tools for generating and displaying online documentation.
- rdoc: rdoc 4.1.1 Documentation
- bugs: Pull requests · rdoc/rdoc · GitHub
RDoc produces HTML and command-line documentation for Ruby projects.
RDoc
includes the +rdoc+ and +ri+ tools for generating and displaying
documentation
from the command-line.
Changes:
- Bug fixes
- RDoc::Options parser should rescue from OptionParser::ParseError.
- Updated example of RDoc::Options to include reopening RDoc::Options.
Pointed out by Michael G. - Moved RubyGems documentation installed message into RDoc hook. For
RubyGems bug #469 by Jeff Sandberg - An Error is now raised when a heredoc is not terminated. Fixes
exceptions
when processing comment blocks. Reported by darix - rdoc --quiet --no-ignore-invalid now exits for invalid options.
Pull
request #192 by Jeremy E. - RDoc::Parser::C no longer ignores a (METHOD) cast in
rb_define_method.
Pull request #184 by Carlos A. - RDoc::Servlet no longer ignores extra directories from -d. Pull
request
#173 by Thomas L. - Fixed
rdoc --ri-site
. Bug #193 by Michal P… - RDoc no longer attempts to parse binary files. Bug #189 by
postmodern,
Bug #190 by Christoffer Lervg, Bug #195 by Aaron P. -
rdoc --pipe
output now containsfor markdown
compliance. - RDoc no longer leaves emacs-style modelines in .txt, .md or .rd
files.
Bug #178 by Zachary S. - RDoc no longer puts raw markup in HTML output for markdown input.
Bug
#204 by Erik H. - Code objects with nodoc are no longer included in the ri store. Bug
#177
by Thomas L… - Text#snippet now creates a RDoc::Markup::ToHtmlSnippet correctly.
- The C parser now de-duplicates call-seq if the same C function is
used for
multiple method names. Bug #203 by Pete H.