RDOC nodoc tag

Ruby
1

Hey Guys,
Is there a way to turn off the rdoc nodoc tag, for example:

#:nodoc:
def not_documented
puts ‘hello’
end
#:some_tag_to_reenable_rdoc:

I do something

def document_me
puts ‘world’
end

Thijs

2

I think it’s #:doc:.

3

#documented

#–
#non documented
#++

#documented

4

simply using # :doc

5

On Jan 15, 2013, at 07:43 , Thijs De vries [email protected] wrote:

Hey Guys,
Is there a way to turn off the rdoc nodoc tag, for example:

Do this instead:

6

#:doc: seems to work.

7

Am Wed, 16 Jan 2013 00:43:13 +0900
schrieb Thijs De vries [email protected]:

def document_me
puts ‘world’
end

Thijs

This is incorrect usage of the :nodoc: directive. It is meant to be
used like this:

def not_documented # :nodoc:
puts ‘hello’
end

This will automatically make RDoc document anything else but those
methods/modules/classes that are marked with :nodoc:. In order to not
document an entire bunch of methods at once, you can use :stopdoc:
and :startdoc::

def foo

Documented

end

:stopdoc:

def bar

Not documented

end

def baz

Not documented either

end

:startdoc:

def blubb

Documented again

end

See here: http://rdoc.rubyforge.org/RDoc/Markup.html#label-Directives

Vale,
Marvin

–
Blog: http://pegasus-alpha.eu/blog

ASCII-Ribbon-Kampagne () | ASCII Ribbon Campaign ()