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
1
vote
5 answers

ERROR: 'rake/rdoctask' is obsolete and no longer supported

Out of the blue, I started getting the following error message: (in /Users/me/.rvm/gems/ruby-1.9.3-p125@mysql2/gems/rails-0.9.5) rake aborted! ERROR: 'rake/rdoctask' is obsolete and no longer supported. Use 'rdoc/task' (available in RDoc 2.4.2+)…
EastsideDev
  • 6,257
  • 9
  • 59
  • 116
1
vote
1 answer

RDoc just my own application?

Is there a way to stop RDoc from going higher than the current directory? i just tried rdoc -O -x ../ but this also stopped it from parsing relative pathes in subdirectories; what I really need is something like: If absolute path of App is…
rhavin
  • 1,512
  • 1
  • 12
  • 33
1
vote
1 answer

Plurals in RDoc documentation

According to the RDoc documentation, names of classes, source files, and any method names containing an underscore or preceded by a hash character are automatically hyperlinked. But links to plurals of class names in RDoc do not work. Therefore in a…
0x4a6f4672
  • 27,297
  • 17
  • 103
  • 140
1
vote
2 answers

Is there a Ruby documentation tool that allows inclusion of diagrams and images?

I am a big fan of doxygen which I have used for years with various languages. In particular, I appreciate its wiki-like ability to include images and run the Graphviz dot generator to have arbitrary inline diagrams from inline DOT code or external…
Andy Dent
  • 17,578
  • 6
  • 88
  • 115
0
votes
1 answer

gem for using rdoc (or other simple markup) syntax for content of pages such as faq, about etc

I want to use rdoc (or yard or simple markup) markup for content of static pages such as faq, about etc. Had a look at high voltage from thoughtbot I would fit my need perfectly if I could also edit the content of these pages. Sort of lightweight…
Wiebew
  • 1
  • 1
0
votes
1 answer

YARD and RDoc compatibility

If I document my code with YARD, and use e.g. the @overload tag, and someone else installs my gem and it generates the documentation with RDoc, won't the result be messy? Is there a good way to deal with this?
mydoghasworms
  • 18,233
  • 11
  • 61
  • 95
0
votes
1 answer

rdoc generated documents publically accessible

I have make rdoc to generate the documentation of my project but now i would like to make them accessible from application so allowed (logged in users) can access/view them from my site. Thanks in advance.
Gul
  • 1,757
  • 2
  • 15
  • 26
0
votes
2 answers

What documentation software is using Ruby on Rails 3.1?

Some time ago I read the changelog of a Ruby on Rails version (I think 3.1.0). In that was written that the documentation "system"/"software" was changed. The current can be browsed here. What is the new documentation software used by Rails? Where I…
user12882
  • 4,702
  • 9
  • 39
  • 54
0
votes
0 answers

How do I fix RDoc 6.5.0 throwing "Tried to load unspecified class: Regexp"?

The error in the screenshot happens whenever I try to run rdoc. It started after I tried to run "rdoc --write-options --exclude ./externals/" to stop it trying to generate docs for everything the projects, including executables. Now, it doesn't get…
CBusBus
  • 2,321
  • 1
  • 18
  • 26
0
votes
0 answers

Generate RDoc docs for gems using version 6.4.0

How can I generate RDoc docs for gems using version 6.4.0? Existing gems have docs generated by 6.4.0. When I install new gems, however, their docs are generated by 6.1.2.1. I'm using the following to install new gems (I don't remember how the…
XDR
  • 4,070
  • 3
  • 30
  • 54
0
votes
0 answers

How to include only specific directories in rdoc?

I'm using rdoc to generate API documentation for my Ruby program, but it's pulling in lots of files I don't care to include in the documentation. I see that there is an option to exclude files by pattern, but it would really be better for me to…
2mac
  • 1,609
  • 5
  • 20
  • 35
0
votes
1 answer

Stuck with rdoc: Any way to add indentation to call-seq?

I know I should use YARD. Not an option in this environment. So I'm using rdoc and call-seq is generally been great, but I want to add indentation for a call-seq that is always used in a block/yield style, something like: call-seq: someFunc { …
0
votes
1 answer

Plugin documention with RDoc in Rails 3

I'm writing a Rails 3 plugin and I'm using Engines. I have and app/ folder in my plugin with controller, models and views. The problem is that when I want to generate documentation with RDoc it won't go into the app/ folder to parse the files in…
adivasile
  • 2,377
  • 3
  • 24
  • 32
0
votes
1 answer

View a rdoc file in a ruby gem

I want to read some of the documentation for the rb-gsl gem. For example the rdoc file for the multimin class. How do I view this file in a browser and follow the links that are in the file (which appear to refer to other rdoc files in the same…
Obromios
  • 15,408
  • 15
  • 72
  • 127
0
votes
0 answers

Documenting constants and methods

I am writing a documentation for my Ruby on Rails 3.0.7 application using RDoc. In the application lib folder, I have the following: module ModuleName class ModuleName::User < ActiveRecord::Base #'CONSTANT' documentation text CONSTANT =…
user502052
  • 14,803
  • 30
  • 109
  • 188