Stopdoc bug in Rdoc

README.md

The presence of #:stopdoc: around a class that should be documented is having an outsized impact as shown with this gist, a minimal reproduction of an issue I found during the development of cartage 2.0.

buggy.rb documents Buggy and Buggy::Documented. When buggy-submodule.rb is parsed, Rdoc does not include Buggy in the generated documentation.

This can be worked around by changing buggy-submodule.rb to look like this:

if true
  class Buggy
    # This class won't be documented, but the presence of stopdoc above means
    # that Buggy won't be documented either.
    module Submodule #:nodoc:
    end
  end

  #:stopdoc:
  class Array
    include Buggy::Submodule
  end
  #:startdoc:
end

buggy-submodule.rb

if true
  #:stopdoc:
  class Buggy
    # This class won't be documented, but the presence of stopdoc above means
    # that Buggy won't be documented either.
    module Submodule
    end
  end
  #:startdoc:
end

buggy.rb

# This class should be documented, but is hidden by the stopdoc in
# Buggy::Submodule.
class Buggy
  # This is documented.
  module Documented
  end
end