Tagged Questions

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 ...

I'm trying to compile openwsman 2.4.12 (and 2.4.10) on a CentOS 7 system and am running into the error below. I've also duplicated the error on a RHEL 7 system as well and don't know what to make of ...

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 wanted to create a DateTime instance for the UTC time zone using the answer from this SOF post that uses the method DateTime#new_offset(0). However, I am not able to find its definition in either ...

I have a readme file in rails project and rake task which generate text file.
I want include content from this file to my Readme.rdoc is it possible
Everything I get after googling - some :include: ...

The exact question is: How can I instruct gem to generate my documentation with Yard. The old way using #has_rdoc doesn't function any more. I cannot find the method to do it using metadata in newer ...

I need to include an example program in my rdoc. The example
program also needs to be executable so that a user can just run
the example from the command line.
I want to show the source code of the ...

I was trying to add docs through rvm, did not run into any errors, then when I went to look at File.open, received the following error. Any ideas?
Mikes-MacBook-Pro:programs mwsage$ rvm docs generate
...

How do I add comments to an attr_accessible field in a Rails class so that it will be picked up by RDoc (or Yard). Here is my sample code, but the comment is not appearing in the generated RDoc files ...

Rake is failing to run after an upgrade to Rails 4 and it was running fine before I upgraded my gems. I am on Ruby 1.9.3. For some reason rdoc doesn't recognize the markup attribute, but I can't find ...

I'm using RDoc for the first time, and I've run into one issue that's a bit bothersome. I have a line in my class documentation like the following:
# * callingState
I also have a class in that same ...