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
2 answers

Where to find good RDoc documentation?

I am using Ruby on Rails 3.0.7 and I would like to document my application. To do that I would to find some "good" documentation about RDoc. Where I can find that? That is, what are "the best" web resource where to find documentation about RDoc?
user502052
  • 14,803
  • 30
  • 109
  • 188
0
votes
1 answer

The "underscore"\"hash" meaning in RDoc

I am using Ruby on Rails 3.0.7 and I am trying to understand how the RDoc system works. So I would like to understand what the "hash" value means when the official documentation refers to that on line 7: Names of classes, source files, and any…
user502052
  • 14,803
  • 30
  • 109
  • 188
0
votes
2 answers

Get and install a new RDoc template

I am using Ruby on Rails 3.0.7 and I would like to install and use a new RDoc template (instead of the default) in order to documenting my application. I would like to choose one of…
user502052
  • 14,803
  • 30
  • 109
  • 188
0
votes
0 answers

How should a Command Pattern inspired class be documented in YARD

While building a Project in Ruby I am required to document every important piece of code with RDoc, using YARD, the bulk of the work is done via Command Patterns Classes (from GOF). The main structure of a Command Pattern is similar to this…
Lomefin
  • 1,173
  • 12
  • 43
0
votes
1 answer

How do I install ri documentation in JRuby?

I installed JRuby 9.2.11.1 on a Windows system. After the installation has successfully completed, no ri documentation for core/stdlib is present. For instance: C:\>ri Array Nothing known about Array I tried this solution How do I install the Ruby…
Franco
  • 669
  • 2
  • 8
  • 23
0
votes
0 answers

Is there a way to use @see and friends in RDoc?

JavaDoc and the like have a way to use @see (the "see also" tag) to link code or add links to external websites. Is there an equivalent in RDoc? Or is the best option just a list of links using {Link text}[http://example.com/]?
Josh
  • 10,961
  • 11
  • 65
  • 108
0
votes
1 answer

Is there a way to force RDoc to not style words, which correspond to classes or modules?

I am trying to write documentation to one of my classes using RDoc and I have the following problem: This is my source: module Native module Facebook # Service, which starts(schedules) Native Facebook Fetching Jobs for users with Facebook…
Marian13
  • 7,740
  • 2
  • 47
  • 51
0
votes
1 answer

How to tell RubyMine what class I'm using when there are name conflicts?

In a Padrino project, Ruby itself is smart enough to know I'm referencing my Page model instead of the paginator's Page class. But RubyMine gets lost and thinks I'm dealing with the pagination and insists in marking some errors (as new arguments…
igorsantos07
  • 4,456
  • 5
  • 43
  • 62
0
votes
2 answers

Why is ri on Windows returning nothing?

When I type ri at the command prompt it returns nothing: Classes and Modules known to ri: How do I set this up properly? Many thanks.
arkana
  • 1
0
votes
2 answers

In gem server "rdoc not installed" but have rdoc in terminal

When I gem server and go to the page, I notice there wasn't a link to the RDoc, and when I move to there a pop out says RDoc is not installed. But when I type rdoc --help in terminal, there is a reply. How to get to the rdoc, because I need to read…
wizztjh
  • 6,979
  • 6
  • 58
  • 92
0
votes
2 answers

Using .gemspec version in documentation/library/script

So, I've been writing a bunch of ruby gems recently, and one thing I would find convenient is to include the current version (as specified in the gemspec) in the rdoc-generated documentation for my libraries, and in the OptionParser-generated --help…
rampion
  • 87,131
  • 49
  • 199
  • 315
0
votes
1 answer

RDoc CONSTANT comments?

In RDoc, is there any way to show constant comments? I would like to comment a constant in a project of mine but and realizing that they dont show up in the RDoc output. I checked documentation which is likely to have comments for their constants,…
msingleton
  • 115
  • 1
  • 2
0
votes
2 answers

how do I process a readme file with rdoc to display ruby script help/usage info

I'd like to keep my usage documenation in a readme file (duh) instead of comments at the top of my script. How do I get RDoc::usage to pull the usage information out of the readme instead of the script comments?
fakeleft
  • 2,830
  • 2
  • 30
  • 32
0
votes
0 answers

How to convert an RDoc file to a single HTML file?

I'd like to convert some RDoc files to corresponding single-page HTML files. The rdoc converter produces a subdirectory and multiple files, and I don't see any command-line option to change that behavior. Is there another tool that can convert an…
mhucka
  • 2,143
  • 26
  • 41
0
votes
1 answer

When does Rails generate a readme.md (as opposed to a readme.rdoc)?

I noticed that when I generate a new rails app sometimes I end up with a readme.md and sometimes with a readme.rdoc (which Bitbucket doesnt automatically render apparentely). If you've got any ideas about that, please let me know.
youssou
  • 88
  • 1
  • 6