lsegal/yard — Issue #490: Certain visibility coding style will hide method docstrings.
Author: jordansissel
Created: 2012-02-13 18:01:58+00:00
State: open

I explicitly set visibility before each method definition, so YARD doesn't see any method docstrings:

class Sample
# Description of this method
#
# blah blah.
#
# @returns [String]
public
def hello
return "Hello"
end

# Another method
public
def world
return "world"
end
end

Because the 'public' method is invoked after the method docstring, this causes YARD to believe the 'def hello' and
'def world' do not have docstrings.

I would like this coding style to be supported, do you see any harm in allowing this?
I can provide patches that enable this behavior, I think; the YARD source code is pretty easy to read.