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
1 answer

dbconfig-common: flushing administrative password rake aborted

I'm trying to install redmine on ubuntu server and when I use the following command : apt-get install redmine redmine-mysql I get the following informations : Lecture des listes de paquets... Fait Construction de l'arbre des dépendances Lecture…
user3596564
  • 1
  • 1
  • 1
0
votes
0 answers

How do I escape double colons in an RDoc comment?

I have a method that looks like this: ## # Opens a file. # # Raises: # +ArgumentError+:: On invalid encoding. # +Errno::ENOENT+:: On invalid file path. # Unfortunately the double colons in Errno::ENOENT is interpreted as the double colons of a…
Hubro
  • 56,214
  • 69
  • 228
  • 381
0
votes
2 answers

OpenVZ web panel cron gives ERROR: 'rake/rdoctask'

I'm using OpenVZ on CentOS 6.5 64bit and every morning I'm getting message with following content: /etc/cron.daily/owp.cron: /usr/lib64/ruby/gems/1.8/gems/rake-10.1.1/lib/rake/rdoctask.rb:2: ERROR: 'rake/rdoctask' is obsolete and no longer…
Besik
  • 43
  • 7
0
votes
1 answer

Make RDoc parse unchanged files too

Is there any parameter to rdoc that tells it to include all unchanged files again, too? Calling rdoc a second (third, fourth) time, just parses the files that have been changed and index.html only shows the content of this parsed file. The other…
Sebastian
  • 151
  • 1
  • 2
  • 6
0
votes
1 answer

How to make RDoc use gemspec configuration

In my gemspec file, I've added configuration for RDoc that doesn't seem to be seen by RDoc. gem.rdoc_options = ['-m', 'README.md'] Given that I've specified the README.md file as the main file, I would expect that running rdoc would respect that.…
Jared
  • 2,408
  • 2
  • 19
  • 33
0
votes
1 answer

rdoc report ++ not documented with a yield inside the method

The document for this method should already include the parameter number. # Iterate and do sth with +number+. def iterate yield(number) end However, rdoc -C1 still reports something is undocumented. # ++ is not documented def iterate();…
canoe
  • 1,273
  • 13
  • 29
0
votes
2 answers

Why does "rvm docs generate" use a different directory for output than "gem server"?

rvm use 2@mygemset rvm docs generate gem server --help prints: Defaults: --port 8808 --dir /home/lsiden/.rvm/gems/ruby-2.0.1-p353@mygemset --no-daemon But: ls /home/lsiden/.rvm/gems/ruby-2.1.0@mygemset/doc is empty. Where did rdocs generate…
Lawrence I. Siden
  • 9,191
  • 10
  • 43
  • 56
0
votes
1 answer

How to force verbatim mode for file inclusion in rdoc

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 program exactly as written in my rdoc formatted…
Steve Madere
  • 509
  • 3
  • 9
0
votes
0 answers

RDoc doesn't parse my .rake files in lib/tasks/*.rake

I can't understand how to instruct RDoc to parse my .rake files in lib/tasks/*.rake. I am new to RDoc but I would like to be able to document each rake command. Also it doesn't seem like the RDoc html has any mention of the text in the 'desc'…
benathon
  • 7,455
  • 2
  • 41
  • 70
0
votes
2 answers

Automating rake doc:app

For you rails programmers, what's the easiest way to keep your RDoc files up-to-date? I know I can run rake doc:app manually, but I really don't feel like adding a manual step to the check-in process, and since we're already using cruisecontrolrb to…
jerhinesmith
  • 15,214
  • 17
  • 62
  • 89
0
votes
1 answer

Commenting rails attr_accessible fields with RDoc

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 (though method commenting works fine): class…
Sean Huber
  • 3,945
  • 2
  • 26
  • 31
0
votes
1 answer

Error with Rake RDoc using Rails 4

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 anything about it getting removed or…
Rust
  • 1
  • 3
0
votes
1 answer

Invalid output formatter when installing a gem

I built a gem for my own usage and when I want to install it I get the following: $ gem install mygem Successfully installed mygem-0.0.1 1 gem installed Installing RDoc documentation for mygem-0.0.1... Invalid output formatter For help on…
Heartcroft
  • 1,672
  • 2
  • 19
  • 31
0
votes
1 answer

How to remove ri and RDoc documentation

How to remove already installed ri and RDoc documentation Installing ri documentation for metric_fu-4.1.0... Installing RDoc documentation for progressbar-0.20.0...
Sam
  • 8,387
  • 19
  • 62
  • 97
0
votes
1 answer

RDoc XML generation

I'm trying to generate a RDoc using the XML format. Here's the command that I'm using: $ rdoc --fmt=xml --opname=api.xml The file is created but no method list is generated. I'm using rdoc (2.4.3). The RDoc template for XML include tags for method…
Nando Vieira
  • 964
  • 10
  • 17
1 2 3
14
15