Use directive hack to make ARGF documentable in other tools
RDoc is able to parse commented blocks of code (inside /**/) as a side-effect of its parsing, but other tools will ignore commented blocks. Using the "#if 0" directive hack is more portable among tools (like YARD) and still allows developers to properly ignore code by commenting it out (assuming the doc tool supports this). Note that the directive hack is already used in io.c (above this line), so this is not a novel methodology.
Note that I opened a pull request on Github also, just in case: https://github.com/ruby/ruby/pull/93
If this is accepted, can it be backported into 1.9.3 as well?
- io.c (Init_IO): use directive hack to make ARGF documentable in other tools. [Bug #6007]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@34576 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
merge revision(s) 34576:
* io.c (Init_IO): use directive hack to make ARGF documentable in other tools. [Bug #6007]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_9_3@34578 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
#2 Updated by nobu (Nobuyoshi Nakada) about 6 years ago
- Status changed from Open to Closed
- % Done changed from 0 to 100