YARD - у тега @param неизвестное имя параметра

Question

Я пытаюсь документировать свой код, используя YARDТем не менее, мне трудно понять, как избавиться от следующего предупреждения:

   $ ~/.gem/ruby/2.3.0/bin/yard 
[warn]: @param tag has unknown parameter name: val 
    in file `lib/wolfsden_myanimelist/values.rb' near line 22
Files:           4
Modules:         2 (    2 undocumented)
Classes:         4 (    2 undocumented)
Constants:       6 (    6 undocumented)
Attributes:     14 (    0 undocumented)
Methods:         4 (    0 undocumented)
 66.67% documented

В следующем коде:

    # @overload episode
    #   Gets last seen episode.
    #   @return [Integer] last seen episode
    # @overload episode=(val)
    #   Sets last seen episode.
    #   @param val last seen episode
    attr_reader :episode
    def episode=(val)
        @status = Integer(val)
    end

Однако я считаю, что именно так ( http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md#Documentation_for_a_Separate_Attribute_Writer) рекомендует делать это именно так. Итак, как я могу избавиться от предупреждения?

Answer 1

Я считаю, что вам нужно указать тип данных для параметра. Это выглядело бы так:

      # @overload episode
#   Gets last seen episode.
# @overload episode=(val)
#   Sets last seen episode.
#   @param [String, Integer] val Last seen episode
#   @return [Integer] Last seen episode
attr_reader :episode
def episode=(val)
    @status = Integer(val)
end

В параметре может быть более одного типа данных - я поставил String а также Integer в, потому что пользователь мог вставить и то, и другое.