From: Patrick May <patrick@...>
Date: 2004-08-30T15:25:09+09:00
Subject: Re: documenting dynamic method with rdoc

Hi,

On Sunday, August 29, 2004, at 07:20  AM, Dave Thomas wrote:

>
> On Aug 29, 2004, at 1:48, Patrick May wrote:
>
>> Is there another prefered way to document this sort of thing with 
>> rdoc?
>
> I'm thinking about it at the moment. I'll probably add a way to 
> document classes and methods that are generated dynamically: I'm just 
> not sure how it should work yet.

My brief thoughts were:

+ 'true' dynamic documentation would require that rdoc execute your 
application, and then pick a point at which to document the code.  
Which seems problematic.

+  generated documentation is less valuable than composed 
documentation, especially when describing how a system behaves at run 
time.  I thought it'd be simpler to tell rdoc "here's a method that 
doesn't exist, but this is what I want to tell people it does".  And 
the stub methods seemed like a straight forward way of doing that.

I don't know what you are thinking about.  My gut feeling was that it 
might not be worth it, though I don't know much about rdoc.

Thanks for rdoc!  I'm looking forward to Pickaxe 2.0 as well.

Cheers,

Patrick