search

zapnap / rdocinfo

New development has moved to http://github.com/lsegal/rubydoc.info
http://rdoc.info
MIT License
18 stars 3 forks source link

rdoc.info does not honor the #-- and #++ Rdoc switches for temporarily turning off the doc generation #36

Closed evolve75 closed 14 years ago

evolve75 commented 14 years ago

Hi,

It appears that rdoc.info does not honor the following RDoc switch usage for temporarily turning off the documentation generation. E,g,

My documentation here ... blah blah blah

Some more

#

--

The previous line should have turned off documentation generation for the subsequent section.

Usually this is where a developer puts internal TODOs etc.

The next line should turn on the documentation generation again

++

What this means is that documentation I wrote for myself (TODOs etc) and not meant for the user to see are not getting listed in the rdoc.info pages!

Help!

evolve75 commented 14 years ago

Dang. The comment submission system is reading the formatting as markdown. So another try. the switches are:

--

and #++

zapnap commented 14 years ago

We use YARD rather than "old school" Rdoc to generate Ruby library documentation: http://github.com/lsegal/yard I believe that particular decision was intentional, but I can't speak to it personally.

evolve75 commented 14 years ago

Wow!

That was a fast response! Thanks for the clarification. I have posted the query on the YARD mailing list (as a wish list item).

Thanks again!