In Files

  • rdoc/stats/verbose.rb

Methods

Class/Module Index [+]

Quicksearch

RDoc::Stats::Verbose

Stats printer that prints everything documented, including the documented status

Public Instance Methods

nodoc(co) click to toggle source

Returns a marker for RDoc::CodeObject co being undocumented

 
               # File rdoc/stats/verbose.rb, line 10
def nodoc co
  " (undocumented)" unless co.documented?
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus