pavlitsky / vscode-yard

YARD comments generator for Visual Studio Code
https://yardoc.org/
MIT License
23 stars 3 forks source link

Don't document methods with malformed parameters #3

Open pavlitsky opened 5 years ago

pavlitsky commented 5 years ago

Add basic validation for method's parameters. If they're invalid then don't document either entire method or only skip its parameters.

Bad params examples:

def foo(bar, baz qux)
end
def foo ; end
pavlitsky commented 5 months ago

Also fix param name in this case, it should parse as other, not |other.

  #
  # <Description>
  #
  # @param [<Type>] |other <description>
  #
  # @return [<Type>] <description>
  #
  def |(other)

  end