How can I refer to a parameter ('@param' tag) from another parameter?
-
30-10-2019 - |
Вопрос
I am using Ruby on Rails 3.1.0 and the YARD 0.7.4 gem for documentation purposes. I would like to refer to a parameter (@param
tag) from another parameter. That is, I have:
# ...
#
# @param [String] argument_1
# Here I would like to have a description text with a reference/link to the
# 'argument_2' parameter (see below)...
#
# Maybe here I can use something like '@param', '{}' or '@macro'... but, how?
#
# @param [String] argument_2
# Some description text...
#
def method_name(argument_1, argument_2)
...
end
Is it possible? If so, how can I make that?
Нет правильного решения
Не связан с StackOverflow