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 --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Talk" group. To post to this group, send email to rubyonrails-talk-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org To unsubscribe from this group, send email to rubyonrails-talk-unsubscribe@googlegroups.com For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en -~----------~----~----~----~------~----~------~--~---
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 On Jan 6, 2008 5:36 AM, Frédéric Mascaro <frederic.mascaro-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:> > 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 > > >-- http://www.jeremymcanally.com/ My books: Ruby in Practice http://www.manning.com/mcanally/ My free Ruby e-book http://www.humblelittlerubybook.com/ My blogs: http://www.mrneighborly.com/ http://www.rubyinpractice.com/ --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Talk" group. To post to this group, send email to rubyonrails-talk-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org To unsubscribe from this group, send email to rubyonrails-talk-unsubscribe@googlegroups.com For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en -~----------~----~----~----~------~----~------~--~---
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? -- Posted via http://www.ruby-forum.com/. --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Talk" group. To post to this group, send email to rubyonrails-talk-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org To unsubscribe from this group, send email to rubyonrails-talk+unsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en -~----------~----~----~----~------~----~------~--~---
On Tue, Mar 24, 2009 at 4:38 AM, Fernando Perez <rails-mailing-list-ARtvInVfO7ksV2N9l4h3zg@public.gmane.org> wrote:> > 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.ppNoMethodError: private method `pp'' called for " foo ":String from (irb):3 from :0>> s.send( :pp, '' foo '' )" foo " => nil -- Greg Donald http://destiney.com/ --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Talk" group. To post to this group, send email to rubyonrails-talk-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org To unsubscribe from this group, send email to rubyonrails-talk+unsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en -~----------~----~----~----~------~----~------~--~---