On Wednesday, March 10, 2004, 8:16:01 PM, Ian wrote:
> Hello,
> When wanting rdoc to avoid documenting a constant intended for private
> use only, this kind of thing used to work:
> #--
> DEFAULT_ID = { 'us' => 'foo',
> 'uk' => 'bar',
> 'de' => 'baz',
> 'jp' => 'qux'
> }
> #++
I never thought that worked but never tried it either. My
understanding is that this is the intention:
#--
# RDoc will ignore this comment,
#++
# but not this one.
def foobar
end
I.e. it is only designed for ignoring comments, not code. Does this
do what you want?
# :stopdoc:
DEFAULT_ID = {}
# :startdoc:
It should.
Cheers,
Gavin
|