Home → Problems →

:doc: modifier ignored

• Edit

adriano.mitre

21 Jan, 2011 08:32 PM

Hi.
The :doc: document modifier, which I use to force documentation of a private method, is ignored by yard.
I already created an issue in GitHub, please vote for it: https://github.com/lsegal/yard/issues#issue/242
Regards,
Adriano

References:
1. http://rdoc.sourceforge.net/doc/index.html
2. https://github.com/adrianomitre/retroactive_module_inclusion

1. Support Staff 1 Posted by lsegal on 22 Jan, 2011 05:21 AM

   

   Hi Adriano,

   As I pointed out in the ticket, :doc: and its :nodoc: counterpart are not supported by yard. You can use --private to achieve the same result, in your case, however.

   Regards,

   Loren

   • Edit

2. lsegal closed this discussion on 22 Jan, 2011 05:21 AM.