From: Dave Thomas <Dave@...>
Date: 2002-06-19T05:52:28+09:00
Subject: Re: attr_overridable?

Bil Kleb <W.L.Kleb@larc.nasa.gov> writes:

> So we're finally getting around to adding Fortran9X parsing to Rdoc
> and have been just noticed Dave using,
> 
>   attr_overridable
> 
> E.g., rdoc/code_objects.rb:382
> 
> What is this thing?

I'm planning to add the equivalent of JavaDoc @xxx tags to RDoc. These
will let you override the attributes that RDoc parses out of source
files, so for example

    def fred(a)

would show fred with a parameter of 'a', but (syntax yet to be
determined)

    # @param: name of the dog (String)
    def fred(a)

would alter the parameter to show 'name of the dog' or whatever. To
differentiate the attributes that can be overridden from those that
cannot, I use 'attr_overridable', a class method in Component.


Cheers


Dave