RDoc 2.5.11

Eric Hodel | Fri, 20 Aug 2010 21:55:16 GMT

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.

2.5.11 / 2010-08-20

  • Minor Enhancements

    • Alias comments are now discovered by the C parser. Reported by Jeremy Evans.

    • Removed —all option which is unused in RDoc. Use the nodoc or stopdoc/startdoc directives to suppress documentation instead.

2.5.10 / 2010-08-17

  • Minor Enhancements

    • Support rb_singleton_class(). Reported by Jeremy Evans.

    • Support rb_define_private_method() on rb_singleton_class(). Reported by Jeremy Evans.

  • Bug Fixes

    • Treat non-ASCII RDoc files as text. Bug #28391 by Kouhei Sutou.

    • Fix potential test failures due to ivar collision. Bug #28390 by Kouhei Sutou.

    • Added duck-typed #aref for RDoc::Attr to RDoc::AnyMethod. Bug #28375 by Erik Hollensbe

    • Fixed method references in HTML output when show_hash is false.

    • Fixed comments with ’.’ in call-seq in C sources. Reported by Jeremy Evans.

    • RDoc now understands singleton aliases. Reported by Jeremy Evans.

Posted in , ,  | no comments

RDoc 2.5.9

Eric Hodel | Wed, 07 Jul 2010 02:39:00 GMT

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 the RDoc Documentation for a description of RDoc’s markup and basic use.

Changes:

  • Bug Fixes

    • Look up pager correctly.

    • Fixed handling of bullets in verbatim sections. Partial patch by Juha-Jarmo Heinonen.

Posted in , ,  | no comments

rdoc-data 2.5.1

Eric Hodel | Thu, 01 Apr 2010 08:15:17 GMT

rdoc-data contains core ri data for use with RDoc 2.5 To install run gem install rdoc-data followed by rdoc-data. This will allow you to look up RDoc for core and standard library files like Kernel, Array or Date. rdoc-data contains ri information for Ruby 1.8.6, 1.8.7 and 1.9.1.

Posted in , ,  | 3 comments

rdoc 2.5

Eric Hodel | Thu, 01 Apr 2010 06:18:55 GMT

rdoc version 2.5 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 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:

NOTE:

You’ll need to: 

  gem install rdoc-data

then run: 

  rdoc-data

to have ri data for core and stdlib like Array or Kernel or Date.

  • 9 Major Enhancements

    • Darkfish now has a “Home” button

    • ri no longer displays the value of a constant. There’s no easy way to make them presentable. Use irb or ruby -e instead. Ruby Bug #549.

    • New ri data format now uses Marshal and pre-builds caches

      • No support for old ri data format, too hard to maintain

      • To upgrade your core ri documentation, install the rdoc-data gem and run rdoc-data

    • RDoc now displays how well you’ve documented your library

    • New recursive-descent parser for RDoc::Markup. See RDoc::Markup::Parser

    • Updated ruby_lex and ruby_token

    • Removed threading support, RDoc is not thread-safe

    • Removed many unsupported options to rdoc

    • Future versions of RDoc will not support Ruby 1.8.6. Bugs filed for 1.8.6-only issues will be (largely) rejected.

  • 17 Minor Enhancements

    • Source Parsing

      • RDoc now supports module aliasing via constant assignment.

      • RDoc now tracks superclasses correctly. Fixes File < IO for core docs.

      • RDoc now ignores methods inside methods.

      • RDoc now ignores Marshal and other binray files.

      • Removed "Skipping require of dynamic string" warning.

      • C parser now handles Document-method better. Bug #27329.

      • API enhancements for writing parsers like the Ruby parser, see RDoc::Parser::RubyTools

    • ri

      • Uses pager over less and more for Debian. Ruby Bug #1171.

      • ri will use the RI_PAGER environment variable to find a pager.

      • ri data generator now supports SIGINFO (^T)

    • When rdoc is in debug mode, ^C now prints a backtrace

    • RDoc::Markup::AttributeManager no longer uses global state.

    • RDoc::RDoc no longer passes around options. Patch #27167.

    • Darkfish won’t generate a file if its template is missing. Patch #25857.

    • Improved some wording for the RDoc main page. Patch #27264, #27268.

    • Removed diagram generation support (to return in the future).

    • Removed external support for RDoc::Task.

  • 12 Bug Fixes

    • The :attr: directives now use the name given to create an attribute. See RDoc::Parser::Ruby#parse_meta_attr.

    • Fix crossrefs on paths with ’-’. Ruby Bug #883.

    • Fix ruby parser for alias with = in the name. Bug #27522.

    • Images are no longer executable. Bug #27156.

    • --op is no longer overridden by --ri. Bug #27054.

    • :method: now works when at the end of a class. Bug #26910.

    • Preserve elipsis from call-seq in Darkfish. Patch #26974.

    • Emacs-style coding: is handled properly. Patch #27388.

    • RDoc::RubyLex now parses UTF-8 identifiers. Bug #26946, #26947.

    • Fixed namespace lookup rules. Bug #26161.

    • Worked around bug in Selenium where they hide a .jar in a .txt file. Filed Selenium bug #27789.

    • Alias comments are no longer hidden. Reported by Adam Avilla.

Posted in , ,  | no comments

RDoc 2.4.2

Eric Hodel | Wed, 25 Mar 2009 23:18:00 GMT

rdoc version 2.4.2 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 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 Minor Enhancements
    • Added --pipe for turning RDoc on stdin into HTML
    • Added rdoc/task.rb containing a replacement for rake/rdoctask.rb. Use RDoc::Task now instead of Rake::RDocTask.
  • 10 Bug Fixes
    • Writing the ri cache file to the proper directory. Bug #24459 by Lars Christensen.
    • Possible fix for Dir::[] and Pathname interaction on 1.9. Bug #24650 by tiburon.
    • Fixed scanning constants for if/end, etc. pairs. Bug #24609 by Ryan Davis.
    • Fixed private methods in the C parser. Bug #24599 by Aaron Patterson.
    • Fixed display of markup on RDoc main page. Bug #24168 by rhubarb.
    • Fixed display of \ character in documentation proceeding words. Bug #22112 by James Gray. See RDoc for details.
    • Fixed parsing and display of arg params for some corner cases. Bug #21113 by Csiszár Attila.
    • Fixed links in Files box. Patch #24403 by Eric Wong.
    • Toplevel methods now appear in Object. Bug #22677 by Ryan Davis.
    • Added back --promiscuous which didn’t do anything you cared about. Why did you enable it? Nobody looked at that page! Oh, it warns, too.

Posted in , ,  | 1 comment

RDoc 2.4.1

Eric Hodel | Fri, 27 Feb 2009 03:19:22 GMT

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:

  • 1 Minor Enhancements
    • Added :attr:, :attr_reader:, :attr_writer:, :attr_accessor: directives. Replaces—accessor. See RDoc::Parser::Ruby for details.
  • 3 Bug Fixes
    • Don’t complain when exiting normally. Bug by Matt Neuburg.
    • Restore—inline-source that warns
    • Fixed links to files in Darkfish output

Posted in , ,  | no comments

RDoc 2.4.0

Eric Hodel | Wed, 25 Feb 2009 06:02:13 GMT

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.

Project Page RDoc Documentation

Changes

  • 9 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
  • 6 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

Posted in ,  | no comments

rdoc, rdoc_chm, rdoc_html_templates 2.3.0 Released

Eric Hodel | Thu, 29 Jan 2009 01:07:00 GMT

RDoc version 2.3.0 has been released!

This release of RDoc brings some big changes. Most notably Michael Granger’s Darkfish generator has become the default output format for RDoc! Michael put a ton of great work into this, and it looks quite lovely. Check out the RDoc documentation for a sample.

rdoc_chm and rdoc_html_templates have been split off from RDoc and released separately as unmaintained software. I don’t plan to make any future changes or updates to rdoc_html_templates (which are for the old HTML generator) ever, but somebody may be interested in taking over maintainership of the rdoc_chm generator.

rdoc will automatically detect rdoc_html_templates and rdoc_chm, so you only need to install them to make them usable via command-line options.

Release notes

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 the RDoc documentation for a description of RDoc’s markup and basic use.

Changes:

  • 3 Major Enhancements
    • Michael Granger’s Darkfish generator is now the default for HTML output
    • Various rdoc generation speedups by Hongli Lai. Patches #22555, #22556, #22557, #22562, #22565.
    • rdoc/discover.rb files are loaded automatically from installed gems
  • 8 Minor Enhancements
    • Added a space after the commas in ri class method lists. RubyForge enhancement #22182.
    • Improved ri—interactive
    • Generators can now override generated file locations
    • Moved unmaintained CHM generator to it’s own package
    • Moved unmaintained extra HTML templates to their own package
    • Removed experimental texinfo generator
    • Converted to minitest
    • Known classes and modules list outputs once per line now for grep
  • 11 Bug Fixes
    • Fix missing superclass in ri output
    • Fix an RDoc crash when told to parse an empty file
    • Ignore nonexistent files instead of crashing
    • .txt and .rdoc files are always considered text. Patch #22897 by Aaron Patterson.
    • When merging ri data with a nonexistant directory, RDoc no longer crashes
    • Fix visibility of methods in XML output. Issue by Yehuda Katz.
    • Fixed relative link generation
    • Fix crash, RDoc now ignores comments above local variable assignments in modules
    • RDoc now only accepts adjacent comments for rb_define_module and rb_define_class
    • C file RDoc is no longer included in token stream
    • Scan all gem paths to match gem name for ri output

Posted in ,  | 2 comments

RDoc 2.1.0

Eric Hodel | Mon, 21 Jul 2008 05:25:39 GMT

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.

  • 3 Major Enhancements:
    • RDoc now knows about meta-programmed methods, see RDoc::Parser::Ruby
    • Reorganized parsers under RDoc::Parser base class
    • ri now walks the ancestors of a class looking for a method e.g. ri File#read displays documentation for IO#read (may require regeneration of ri data)
  • 5 Minor Enhancements:
    • Allow links to files
    • Default options now taken from RDOCOPT environment variable
    • Class method documentation can be found at toplevel now (def X.foo)
    • 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)
    • `rdoc -v` prints out files, classes, modules and methods as it goes
  • 11 Bug Fixes:
    • `ri Foo.bar` now looks for class methods also
    • Sections work in the default template again
    • Doesn’t warn about :foo:: list item being an unrecognized directive
    • RDoc no longer converts characters inside tt tags
    • Fixed “unitialized constant RDoc::Markup::ToHtml::HTML”
    • Fixed generation of relative links
    • Fixed various diagram generation issues
    • Fixed templates broken by switch to erb
    • Fixed issue with <!- -> style comments
    • Lowercase words are no longer rdoc’d as methods without leading #, as described in the documentation
    • RDoc now correctly sets superclasses if they were originally unknown

Posted in ,  | no comments

RDoc 2.0.0

Eric Hodel | Fri, 11 Apr 2008 01:21:00 GMT

rdoc version 2.0.0 has been released!

http://rubyforge.org/projects/rdoc

http://rdoc.rubyforge.org/rdoc

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.

Changes:

  • 3 Major Enhancements:
    • Renamespaced everything RDoc under the RDoc module.
    • New `ri` implementation.
      • Reads from a cache in ~/.ri/ for enhanced speed.
      • RubyGems aware, only searches latest gem versions.
    • Now up to over 100 tests and 200 assertions.
  • 4 Minor Enhancements:
    • Switched to an ERb-based TemplatePage, see RDoc::TemplatePage.
    • Class/module ri now displays attribute and constant comments.
    • Cross-references can be disabled with a leading \.
    • Relaxed parsing for some RDoc inline markup.

Bugs:

If you found a bug, please report it at the RDoc project's tracker on RubyForge: http://rubyforge.org/tracker/?group_id=627

Synopsis:

  gem 'rdoc'
  require 'rdoc/rdoc'
  # ... see RDoc

Posted in ,  | 4 comments

Older posts: 1 2