RDoc and blocks in class definitions

ruby-talk
1

Hi.

I use an ExceptionFactory to create some custom exceptions. These
Exceptions are defined in a class and I wanted to document them.
However.. rdoc seems to have considerable trouble with them.

It's rather hard to explain what goes wrong with the HTML generation, so
I'll insert a small example file here:

···

---
# Some nice test class
class Foo

  # Some exception used in this class:
  # A foo exception
  FooException = ExceptionFactory.new("foo")
  # A bar exception
  BarException = ExceptionFactory.new("bar") do
    a = 0
  end

  # Create a new foo!
  def initialize
  end

end # Foo
---

When 'a = 0' is commented out, thus creating an emtpy block, or the block
is removed there is no problem and Foo#initialize gets documented.
If not.. strange things happen. :slight_smile:

It seems :call-seq: or something alike is available for constants. Is
there an alternative for documenting these Exception classes?
Is there a workaround for this problem or maybe.. a fix?

Greetings, TIA,

Paul

--
Student @ Eindhoven | JID: paul@luon.net
University of Technology, The Netherlands | email: paul@luon.net

Using the Power of Debian GNU/Linux <<< | GnuPG: finger paul@luon.net