RDoc - hidden documentation

rubyonrails-talk
1

Hi,

I generated the RDoc documentation for Rails 2.0.2 via rake, but many classes are not present in the documentation. For example the class "CGI::Session::CookieStore" is hidden even if its file is visible in the files list (vendor/rails/actionpack/lib/action_controller/session/ cookie_store.rb).

Why and how to generate the documentation for those classes?

I also update the "documentation.rake" to show all methods (option "-- all"), but it doesn't work.

Have you a solution?

Thanks.

Frédéric Mascaro

2

They are likely marked ":nodoc:" in the source, which means RDoc is supposed to skip them. To get around that you need to hack RDoc, but you can view documentation generated by skipping those nodoc commands at http://caboo.se/doc.html.

--Jeremy

3

Jeremy McAnally wrote:

They are likely marked ":nodoc:" in the source, which means RDoc is supposed to skip them.

Why is the documentation for these methods hidden from the public? The method is still invokable. If really they wanted people to not know about such methods and to prevent them from using them, why not make these methods as protected/private or change how the encapsulation is done?

Making them private doesn't make them inaccessible. In Ruby nothing is really private like one might expect from experience with Java or C++.

irb

s = ' foo '

=> " foo "

s.private_methods.include? 'pp'

=> true

s.pp

NoMethodError: private method `pp' called for " foo ":String         from (irb):3

s.send( :pp, ' foo ' )

" foo " => nil