Posted By: Designing Patterns
Date: 2008-09-20 01:09
Summary: rdoc 2.2.0 Released
Project: rdoc
rdoc version 2.2.0 has been released!
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 the 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.2.0 / 2008-09-19 This version includes some significant enhancements to ri. See RI.txt for documentation about ri.
* 5 Major Enhancements * More extensive unit tests (special thanks to Chris Lowis for contributing a test). * Made ri twice as fast for the most common use case of displaying information for a class or a fully-qualified method (i.e., ri Array#flatten, after ri has created a cache the first time that it runs). * Made ri many times faster when searching for an unqualified method (i.e., ri read, again after the first such search has populated ri's cache) * Changed ri to do regular expression searches for unqualified methods; now, a regular expression for a method can be passed to ri on the command-line. * Added an interactive mode to ri (patch by Daniel Choi). Now, when ri is given a -i argument, it will allow the user to disambiguate unqualified methods if more than one is present and also will allow a user to get information for a class' method.
* 8 Minor Enhancements * RDoc now adds the package title to the web pages that it generates for files and classes/modules, which helps them appear better in search engine results. * RDoc now automatically generates cross-reference links for classes and methods specified relative to the global namespace (i.e., ::A::B::C#method). * All built-in templates now output valid, strict XHTML. * The documentation is slightly better organized (the markup details were merged into the RDoc module's documentation). * Improved rdoc's HTML generation speed by about 20% (on Windows, the boost seems larger). * Provided an ri command-line option to control its caching behavior. * Improved RDoc's documentation. Added RI.txt to document ri. * Allow HTML templates distributed as gems to be loaded with the -T option, just like the standard templates in rdoc/generator/html (so an HTML template lib/new_template.rb in a gem can be used with rdoc -T new_template)
* 25 Bug fixes: * Fixed prototype detection in C parser. Can process ruby 1.8 C files again. * Fixed the main page for frameless template. Patch by Marcin Raczkowski. * Fixed the main page for frame templates. Now, if no main page is specified, RDoc will default to the README. * Fixed missing stylesheet in generated chm. Patch by Gordon Thiesfeld. * Fixed the parsing of module names starting with '::'. Patch by Giuseppe Bilotta. * Fixed a case where RDoc first would encounter Foo::Bar and then would encounter class Foo. Previously, RDoc erroneously would have considered that both a Foo class and a Foo module existed. * Fix a clase where RDoc would not generate correct cross-reference links to a class contained within a module of the same name (i.e. RDoc::RDoc) * Prevented RDoc from trying to parse binary files, which would produce garbage output. * RDoc now correctly converts ' characters to apostrophes, opening single quotes, and closing single quotes in most cases (smart single quotes). * RDoc now correctly converts " characters to opening double quotes and and closing double quotes in most cases (smart double quotes). * (c) correctly is converted into the copyright symbol. * '&' characters in text now correctly are translated to HTML character codes. * Fixed missing stylesheet in generated chm. Patch by Gordon Thiesfeld. * Fixed broken method links in the built-in templates. * RDoc properly links to files and classes in the one page HTML template. * The kilmer and hefss templates properly syntax highlight when inlining source code. * The kilmer and hefss template class pages properly display methods again. * Fixed broken class, file, and method links in the frameless template. * Fixed the clipping of source code in the html and frameless templates when the source code cannot fit into the window; a scrollbar now will allow all of the source code to be viewed. * Fixed the missing constant descriptions in the html and frameless templates. * Fixed the ri command-line options that customize the directories to be searched for documentation. * Fixed the XML generator. Patch by Anthony Durity. * Stopped the XML template from generating invalid XML due to malformed embedded ruby. * Adding missing information about a class' constants to the XML template. * Fixed the horizontal rule markup (---) so that it correctly adds a horizontal rule rather than suppressing all text that follows. |
|