Questions tagged [rdoc]

RDoc is the default embedded documentation generator for Ruby. Rdoc generates structured documentation that can be accessed via a web browser or the command-line by analyzing the code and specially formatted comments. Even in the absence of comments, rdoc will generate documentation using a programs structure.

RDoc analyzes Ruby source code to generate documentation. In the absence of comments, Rdoc uses the programs structure to produce documentation. With comments, which can be specially formatted using RDoc Markup, RDoc can create very detailed and useful documentation. Documentation generated via rdoc is accessible through the command line using ri. The RDoc Project's source code repository is hosted via github. RDoc was designed by Dave Thomas.

214 questions
0
votes
3 answers

Gem Server and Rails RDoc Not Found

I would like to read Rails documentation locally though gem server. I go to http://localhost:8808/ and Rails 2.3.3 gem is in the list of the gems installed, but when I click [rdoc] I get: `/doc_root/rails-2.3.3/rdoc/index.html' not found. I tried…
collimarco
  • 34,231
  • 36
  • 108
  • 142
0
votes
1 answer

What's the most common way for including a howto/documentation in a ruby-gem?

I saw that if the gem is installed also the rdoc is generated and you can access the rdoc by gem server #->localhost:8808 I am thinking of the most common ways how to describe a ruby-developer how to use the gem that was installed. Where i am…
noircc
  • 650
  • 10
  • 28
-1
votes
1 answer

"Nothing known about..." message when trying to view documentation

I'm quite new to ruby and I'm trying to view Ruby documentation through command prompt (I'm on Windows 7, Ruby version 2.0.0p195). However, no matter which command I try, for example ri String#upcase, I always get the message "Nothing known…
-1
votes
3 answers

What parts of a Ruby-on-Rails application (with reasonably expressive unit tests) should have RDoc?

I'm developing an open-source web application on top of Rails. I'd like to make my code as easy to understand and modify as possible. I'm test-driving my development with unit tests, so much of the code is "documented" through test cases (what…
Glen E. Ivey
  • 327
  • 2
  • 6
1 2 3
14
15