Exlcude method from rdoc

ruby-talk
1

What's the sytax to exclude a method form a generated rdoc? Just a
method in a class, not an entire class or module.

Thanks in advance,
-Alex

···

--
Posted via http://www.ruby-forum.com/.

2

Alex Wayne wrote:

What's the sytax to exclude a method form a generated rdoc? Just a
method in a class, not an entire class or module.

def foo # :nodoc:
end

Works with class defs too.

···

--
      vjoel : Joel VanderWerf : path berkeley edu : 510 665 3407

3

Joel VanderWerf wrote:

Alex Wayne wrote:

What's the sytax to exclude a method form a generated rdoc? Just a
method in a class, not an entire class or module.

def foo # :nodoc:
end

Works with class defs too.

Thank you, I wasn't sure if that would nuke the documentation for the
entire module or not.

···

--
Posted via http://www.ruby-forum.com/\.