Forum: Ruby exlcude method from rdoc

Announcement (2017-05-07): www.ruby-forum.com is now read-only since I unfortunately do not have the time to support and maintain the forum any more. Please see rubyonrails.org/community and ruby-lang.org/en/community for other Rails- und Ruby-related community platforms.
D0cd6b10e01bacb976b3b815a9c660bc?d=identicon&s=25 Alex Wayne (Guest)
on 2006-06-04 04:35
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
47b1910084592eb77a032bc7d8d1a84e?d=identicon&s=25 Joel VanderWerf (Guest)
on 2006-06-04 04:54
(Received via mailing list)
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.
D0cd6b10e01bacb976b3b815a9c660bc?d=identicon&s=25 Alex Wayne (Guest)
on 2006-06-04 05:04
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.
This topic is locked and can not be replied to.