Warning in yard with @param tag
-
18-06-2021 - |
Question
I was trying to document some Ruby code using yard
and even though I am doing exactly what is described here or here
# @param [Integer] the number of trials (>= 0)
# @param [Float] success probability in each trial
def initialize(n, p)
# initialize...
end
I still get this strange error though
@param tag has unknown parameter name: the
@param tag has unknown parameter name: success
and then the generated html looks wierd. I am calling yard
this:
$ yard doc -m markdown
What could I be doing wrong?
La solution
doc says @param tag has format
@param [Type] name description
and your lines do not include param names (n and p respectively)
Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow