castwide / solargraph

A Ruby language server.
https://solargraph.org
MIT License
1.87k stars 154 forks source link

`see` for params doesn't seem to be picked up by solargraph #696

Open renatolond opened 7 months ago

renatolond commented 7 months ago

With this class

class FooBar
  # @param param [String] My Cool Param
  def method1(param); end

  # @param param (see #method1)
  def method2(param); end
end

(I realize in the screenshots it's showing the name param1, but I fixed it and the result is the same)

If I generate the yard docs, method2 gets the params described: image

However, it seems that solargraph does not pick up the param for method2: image While it picks up for method1: image

It seems using the see for all params also does not work

class FooBar
  # @param param1 [String] My Cool Param
  def method1(param); end

  # @param (see #method1)
  def method2(param); end
end

Solargraph version:

❯ solargraph -v
0.49.0
castwide commented 7 months ago

The (see x) syntax isn't currently supported in Solargraph, but it's useful enough that I'll try to get it into the next release.