How to declare array of a particular type in ruby documentor?

Question

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

The main reason, to make RubyMine (or another IDE) work for autocomplete stuff, clickable methods, refactoring, etc., in right way.

In PHP will look like:

/**
 * @param array $items
 * @param Filter[] $filters
 * @return Result[]
 */
function filter($items, $filters) {}

I'm just not sure if it can work in similar way in RubyMine:

##
# @param [Array] items
# @param [Filter[]] filters
# @return [ResultClass[]]
#
def filter(items, filters); end

Extra example in PHP:

class My
{
    public $name;
}

/**
 * @return My[]
 */
function foo()
{
      // Similar code here
      //return [new My(), new My()];
}

function show()
{
    foreach (foo() as $item) {
        // IDE will make autocomplete for My::$name
        echo "$item->name\n";
    }
}

IIRC, `@return [Array]` should work. – Stefan Sep 03 '18 at 12:52 — Stefan, Sep 03 '18 at 12:52

score 5 · Accepted Answer · edited Mar 06 '19 at 15:22

5

class TheClass
  # @param items   [Array]
  # @param filters [Array<Filter>]
  # @return        [Array<TheClass>]
  def filter(items, filters); end
end

As documented YARD Tags.

edited Mar 06 '19 at 15:22

Hosam Aly

41,555
36
141
182

answered Sep 03 '18 at 13:01

Andrey Deineko

51,333
10
112
145

am I right `# @param filters [Filter]` means just `filters == Filter` in your example? – Kirby Sep 03 '18 at 14:00
@Kirby the form is as following: [@param] [function parameter name] [function parameter type] – Andrey Deineko Sep 03 '18 at 14:02
And, just to clarify, in `@return` it means `[TheClass.new, TheClass.new, ...]`, doesn't it? – Kirby Sep 03 '18 at 14:02
@Kirby it means array of instances of `TheClass` – Andrey Deineko Sep 03 '18 at 14:03
@param name type - it's absolutely clear. I mean in my example filters suppose to an array with Filter objects. – Kirby Sep 03 '18 at 14:05
@AndrewDeineko, ok got it. It's definitely what I need. Thank you! – Kirby Sep 03 '18 at 14:05
1

@Kirby I misunderstood, if `filters` is an array it should be `@param filters [Array]`. I think you can specify the class of these objects with `@param filters [Array]` – Andrey Deineko Sep 03 '18 at 14:07

How to declare array of a particular type in ruby documentor?

1 Answers1