From: Rob Biedenharn <Rob@...>
Date: 2007-01-03T06:18:04+09:00
Subject: Re: Question on rdoc, unwanted hyperlinked methods


On Dec 31, 2006, at 9:55 PM, Dave Thomas wrote:

> On Dec 31, 2006, at 8:26 PM, Daniel Berger wrote:
>
>> The word 'test' in both cases ends up hyperlinked to the test  
>> method, even though I don't want it to.  It thought you had to  
>> write it as Foo#test, or use 'link:', in order to get a hyperlink  
>> like that. Is this a bug?
>
> Nope. Debatable, perhaps. But it's the way I intended it.
>
> Dave

Perhaps you're looking for the #:nodoc: tag that stops a method (or  
constant or class) from being included in the output:

class Foo
   # This is a test constant
   XXX = 99     #:nodoc:

   # I just want to use the word test here without it becoming a  
hyperlink
   def test     #:nodoc:
      puts "Hello"
   end
end

Of course, you could just:
class Foo      #:nodoc:
...
end
to stop rdoc generation for the whole Foo class.

-Rob

Rob Biedenharn		http://agileconsultingllc.com
Rob@AgileConsultingLLC.com