List Info

Thread: rdoc has issues with multi-line constant defs




rdoc has issues with multi-line constant defs
country flaguser name
United States
2007-09-15 23:59:03
I'm investigating why I can't get any useful rdoc output for
the HTTPClient 
library. (http://dev.ctor.org/
http-access2)

I've created a test case that illustrates the problem I've
found.  It appears 
that the rdoc program ignores documented methods when there
is multiple-line 
constant definitions in the source-file.

With the attached test case, if I run rdoc on it as-is, I
get no HTML 
documentation for the initialize() and get_content()
functions.  However, if I 
remove the SSLEnabled and SSPIEnabled definitions, then rdoc
will generate 
HTML documentation for initialize() and get_content().

Can anyone confirm this behavior?
Is this a bug in rdoc?  Or is there something wrong with the
HTTPClient code?

  
Re: rdoc has issues with multi-line constant defs
country flaguser name
United States
2007-10-10 12:13:04
On Sep 15, 2007, at 21:59 , Brian Sammon wrote:
> I'm investigating why I can't get any useful rdoc
output for the  
> HTTPClient  library. (http://dev.ctor.org/
http-access2)
>
> I've created a test case that illustrates the problem
I've found.   
> It appears that the rdoc program ignores documented
methods when  
> there is multiple-line constant definitions in the
source-file.
>
> With the attached test case, if I run rdoc on it as-is,
I get no HTML
> documentation for the initialize() and get_content()
functions.   
> However, if I remove the SSLEnabled and SSPIEnabled
definitions,  
> then rdoc will generate HTML documentation for
initialize() and  
> get_content().
>
> Can anyone confirm this behavior?
>
> Is this a bug in rdoc?  Or is there something wrong
with the  
> HTTPClient code?

I believe this is a bug in RDoc.

--
Poor workers blame their tools. Good workers build better
tools. The
best workers get their tools to do the work for them. --
Syndicate Wars




Re: rdoc has issues with multi-line constant defs
country flaguser name
United States
2007-10-10 12:13:04
On Sep 15, 2007, at 21:59 , Brian Sammon wrote:
> I'm investigating why I can't get any useful rdoc
output for the  
> HTTPClient  library. (http://dev.ctor.org/
http-access2)
>
> I've created a test case that illustrates the problem
I've found.   
> It appears that the rdoc program ignores documented
methods when  
> there is multiple-line constant definitions in the
source-file.
>
> With the attached test case, if I run rdoc on it as-is,
I get no HTML
> documentation for the initialize() and get_content()
functions.   
> However, if I remove the SSLEnabled and SSPIEnabled
definitions,  
> then rdoc will generate HTML documentation for
initialize() and  
> get_content().
>
> Can anyone confirm this behavior?
>
> Is this a bug in rdoc?  Or is there something wrong
with the  
> HTTPClient code?

I believe this is a bug in RDoc.

--
Poor workers blame their tools. Good workers build better
tools. The
best workers get their tools to do the work for them. --
Syndicate Wars




[1-3]

about | contact  Other archives ( Real Estate discussion Medical topics )