From: Quintus <quintus@...>
Date: 2013-01-17T03:58:46+09:00
Subject: Re: RDOC nodoc tag

--Sig_/eAV8fQQyxmifafv7pVn/D/O
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

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

> Hey Guys,
> Is there a way to turn off the rdoc nodoc tag, for example:
>=20
>   #:nodoc:
>   def not_documented
>     puts 'hello'
>   end
>   #:some_tag_to_reenable_rdoc:
>=20
>   # I do something
>   def document_me
>     puts 'world'
>   end
>=20
> Thijs
>=20

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

--=20
Blog: http://pegasus-alpha.eu/blog

ASCII-Ribbon-Kampagne        ()   | ASCII Ribbon Campaign        ()
- Stoppt HTML-E-Mail         /\   | - Against HTML E-Mail        /\
- Stoppt propriet=C3=A4re Anh=C3=A4nge      | - Against proprietary attachm=
ents
www.asciiribbon.org/index-de.html | www.asciiribbon.org

--Sig_/eAV8fQQyxmifafv7pVn/D/O
Content-Type: application/pgp-signature; name=signature.asc
Content-Disposition: attachment; filename=signature.asc

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.19 (GNU/Linux)

iQEcBAEBAgAGBQJQ9vY9AAoJELh1XLHFkqhaL/sH/3yz8ZqJhE4UaYhxw9l33OEJ
N5dT1Nrw96jCRfxhSViOWI+AiCvu5hZoUcdVd4CD/zCQpl5zub3HeA/9OZHaMaAg
sTjzA9zvD7dpsfI+fg8PA8xyIoc0hY81OLqCSfMe18m7z2sOWRvYpMtEqQJ+y2iV
q9K/asNjpilxQDPEWUSTYiozuYYhnM7FrjRGN7+hMLSKZQEnXrESKa31swL3mmuH
O/uQ8FIDKcF7TYhA5Y6zrQBJWh1s4Qzt2l7XumnefWC9mwbnBfoVlCdUSEYYYgqS
CTth00EUWtzhmK4ffOAXRflAH9PqK1iQokbF3kmJVp7y2oP9yVVKifrlA5zOP8c=
=MGtI
-----END PGP SIGNATURE-----

--Sig_/eAV8fQQyxmifafv7pVn/D/O--