rdoc has issues with multi-line constant defs
Brian Sammon <[email protected]> Sun, 16 Sep 2007 00:59:03 -0400
| Newsgroups | gmane.comp.lang.ruby.documentation |
|---|---|
| Message-ID | <E1IWmDn-000319-JX@necz1> |
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?
test.rb
(text/plain, 549 B)
class HTTPClient
SSLEnabled = begin
require 'openssl'
true
rescue LoadError
false
end
SSPIEnabled = begin
require 'win32/sspi'
true
rescue LoadError
false
end
# SYNOPSIS
# Client.new(proxy = nil, agent_name = nil, from = nil)
def initialize(proxy = nil, agent_name = nil, from = nil)
@proxy = nil
end
# SYNOPSIS
# Client#get_content(uri, query = nil, extheader = {}, &block = nil)
def get_content(uri, query = nil, extheader = {}, &block)
'no content'
end
end