Bug #1718
closed
RDoc directive in lib/yaml/tags.rb prevents rdoc'ing of Module
Description
=begin
This appears to be a regression. There is a :stopdoc: directive in lib/yaml/tags.rb that modifies Module.
When running rdoc over the Ruby source tree, this stops the rdoc'ing of the entire Module code; no docs page for Module is created.
This was a problem once before, and was fixed (I submitted a patch, which was accepted), but now seems to have returned. Removing that rdoc directive allows for Module to be doc'ed (though there is still the larger issue of RDoc pollution with Yaml methods now appearing as part of Module in the resulting RDoc files).
=end
Updated by drbrain (Eric Hodel) almost 15 years ago
=begin
On Jul 2, 2009, at 14:06, James Britt redmine@ruby-lang.org wrote:
Bug #1718: RDoc directive in lib/yaml/tags.rb prevents rdoc'ing of
Module
http://redmine.ruby-lang.org/issues/show/1718Author: James Britt
Status: Open, Priority: Normal
ruby -v: ruby 1.8.6 (2009-03-27 patchlevel 367) [i686-darwin9.7.0]This appears to be a regression. There is a :stopdoc: directive
in lib/yaml/tags.rb that modifies Module.When running rdoc over the Ruby source tree, this stops the
rdoc'ing of the entire Module code; no docs page for Module is
created.This was a problem once before, and was fixed (I submitted a patch,
which was accepted), but now seems to have returned. Removing that
rdoc directive allows for Module to be doc'ed (though there is still
the larger issue of RDoc pollution with Yaml methods now appearing
as part of Module in the resulting RDoc files).
Pairing the stopdoc with a startdoc after the YAML methods should keep
the Module documentation without the YAML additions.
=end
Updated by wyhaines (Kirk Haines) about 14 years ago
- Status changed from Open to Closed
- % Done changed from 0 to 100
=begin
This issue was solved with changeset r26819.
James, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.
=end