Forum: Ruby RDOC nodoc tag

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

I think it's #:doc:.

#documented

#--
#non documented
#++

#documented

On Jan 15, 2013, at 07:43 , Thijs De vries <lists@ruby-forum.com> wrote:

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

Do this instead:

simply using # :doc

#:doc: seems to work.

Am Wed, 16 Jan 2013 00:43:13 +0900
schrieb Thijs De vries <lists@ruby-forum.com>:

>   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        ()
- Stoppt HTML-E-Mail         /\   | - Against HTML E-Mail        /\
- Stoppt proprietäre Anhänge      | - Against proprietary attachments
www.asciiribbon.org/index-de.html | www.asciiribbon.org