hey everyone i was looking for a documentation for my project when i google it i found Rdoc but can not understand what exactly this Rdoc does. can any one help me to know about Rdoc. thanks in advance -- 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-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org To unsubscribe from this group, send email to rubyonrails-talk+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en.
RDoc[1] is a documentation generator, it''s both a markup[2] and a parser. All you need to get started is the rdoc gem: gem install rdoc Then all you need to do is add some rdoc flavored comments to your source code, and the ''rdoc'' command from your source tree will generate html pages for all your code. There are plenty of other documentation generators for Ruby[3], find one that works for you; I personally prefer rdoc and rocco, but you''ve got lots of options. 1: http://rdoc.rubyforge.org/ 2: http://rdoc.rubyforge.org/RDoc/Markup.html 3: https://www.ruby-toolbox.com/categories/documentation_tools On Thu, Feb 2, 2012 at 7:26 AM, honey ruby <emailtohoneyruby-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:> hey everyone i was looking for a documentation for my project when i > google it i found Rdoc but can not understand what exactly this Rdoc > does. can any one help me to know about Rdoc. > > thanks in advance > > -- > 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-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org > To unsubscribe from this group, send email to rubyonrails-talk+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org > For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en. >-- 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-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org To unsubscribe from this group, send email to rubyonrails-talk+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en.
gem server On Feb 2, 6:26 am, honey ruby <emailtohoneyr...-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:> hey everyone i was looking for a documentation for my project when i > google it i found Rdoc but can not understand what exactly this Rdoc > does. can any one help me to know about Rdoc. > > thanks in advance-- 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-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@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.
thanks yeah it worked but i run this command "rake doc:app" and in in doc folder i got the HTML pages. when i open those HTML files i can see my code in a colorful format. this is what rdoc is for nothing more than that? On Thu, Feb 2, 2012 at 8:23 PM, Zachary Scott <zachary-4QbFbDRPr4TGjR/E9haiUg@public.gmane.org>wrote:> RDoc[1] is a documentation generator, it''s both a markup[2] and a > parser. All you need to get started is the rdoc gem: > > gem install rdoc > > Then all you need to do is add some rdoc flavored comments to your > source code, and the ''rdoc'' command from your source tree will > generate html pages for all your code. > > There are plenty of other documentation generators for Ruby[3], find > one that works for you; I personally prefer rdoc and rocco, but you''ve > got lots of options. > > 1: http://rdoc.rubyforge.org/ > 2: http://rdoc.rubyforge.org/RDoc/Markup.html > 3: https://www.ruby-toolbox.com/categories/documentation_tools > > > On Thu, Feb 2, 2012 at 7:26 AM, honey ruby <emailtohoneyruby-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> > wrote: > > hey everyone i was looking for a documentation for my project when i > > google it i found Rdoc but can not understand what exactly this Rdoc > > does. can any one help me to know about Rdoc. > > > > thanks in advance > > > > -- > > 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-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org > > To unsubscribe from this group, send email to > rubyonrails-talk+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org > > For more options, visit this group at > http://groups.google.com/group/rubyonrails-talk?hl=en. > > > > -- > 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-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org > To unsubscribe from this group, send email to > rubyonrails-talk+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org > For more options, visit this group at > http://groups.google.com/group/rubyonrails-talk?hl=en. > >-- 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-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org To unsubscribe from this group, send email to rubyonrails-talk+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en.