From: Dave Thomas <Dave@...>
Date: 2001-12-19T13:34:59+09:00
Subject: [ruby-talk:28891] ANN: RDoc now (attempts to) support blocks


Following some sourceforge discussions with Matt Armstrong, RDoc now
tries to show the parameters passed to a block from a method. It does
this in two ways:

1. If a method contains a 'yield', it takes the parameters to that
   yield and displays them in the method synopsis.

      def fred(obj)
        # ...
        yield line, address

   is documented as

      fred(obj) { |line, address| ... }

2. You can override this using a special comment that must appear at
   the end of the 'def' part of the method definition:

      def fred(obj)  # yields: wilma, betty
        # ...
        yield line, address

   is documented as

      fred(obj) { |wilma, betty| ... }


I haven't made a full release for this change, but it's available from
CVS on SourceForge:

    https://sourceforge.net/cvs/?group_id=42128


Cheers


Dave