Let's say I have the following function: @param foo [Array<String>] def recursive_split(foo) bar = [] foo.each do |elem| bar.append(ele ...

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

The following is a snippet of a method that accepts an array of strings or a blank array([]): # @param [Array<String>] bar def foo(bar) if ba ...

My class delegates a method to another object (which I'll call the helper object). I want to include documentation of that method in the delegating cl ...

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

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

I'd like to declare an array of objects with the exact object class in rubydoc for either a parameter or variable, or for @return. (it must be RDoc?.. ...

In PHP we can describe any variable and get proper auto-complete in an IDE like PHPStorm. Is there some way to make it in RubyMine by using RDoc? ...

I want a piece of code, like a hash, to display with fixed typeface on the resulting html. Suppose this is the contents of my file: How to instruct ...

I am working on a very large rails project and I want to standardize the usage of rdoc in the codebase. I figured I could run it once over the whole p ...

After searching the RDoc documentation I can't find how to document a file / a top-level method in RDoc... Suppose I have the following code : Run ...

I have inherited a bunch of Ruby code with rdoc comments, but many of the options and attributes are multi-line, such as: The end result is really ...

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

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

I'm getting this error when running my script: from I have rdoc in my Gemfile and I have also tried without specifying version. In my script ...

For example, The NoMethodError exception keeps being raised when I install any new gem. I googled about it and searched issues in RDoc and RubyGems ...

I was just trying to generate the documentation for my gem, and upon running either rdoc or yard I got the error What is going on? I've trying rein ...

When trying to create the documentation of my rails controller and the used parameters I'm getting stuck because yard seems to expect, that the parame ...

The official documentation indicates that I should be able to build documentation for my application using rake doc:app, but when I run the command in ...

I have open rails console and want to use pluralize method but i am getting error as NoMethodError: undefined methodpluralize' for main:Object` plura ...