From: Ken Bloom <kbloom@...>
Date: 2006-07-14T02:35:17+09:00
Subject: Re: rdoc and constructs like DL::Import's extern

Logan Capaldo <logancapaldo@gmail.com> wrote:
> 
> On Jul 12, 2006, at 6:40 PM, Ken Bloom wrote:
> 
>> Is there any way to get rdoc to document all of the methods that the
>> option method automatically creates?
>>
>> I have noticed that rdoc doesn't even know how to do it for the  
>> methods
>> created by DL::Import.extern. (I haven't worked with rails, but I
>> imagine rails has a similar problem.)
> 
> You could maybe make stubs for documentation purposes:
> 
> e.g. In some file parseoptions_doc.rb (that doesn't ever even get  
> included)
> 
> class ParseOptions
>   # This method frobinates the baz
>   def max_sentence_length(baz)
>   end
> 
>   # this method somethings the whodinger
>   def cost_model_type
>   end
> end
> 
> You just don't use this file in your actual code but when you run  
> rdoc over it, it should pick up the methods

Then I still have to write all of the stubs. Although I suppose I
could make it automatically generated somehow.

--Ken Bloom

-- 
I usually have a GPG digital signature included as an attachment.
See http://www.gnupg.org/ for info about these digital signatures.