lsegal / yard

YARD is a Ruby Documentation tool. The Y stands for "Yay!"
http://yardoc.org
MIT License
1.92k stars 394 forks source link

Is there a way to define reusable type definitions? #1513

Open KonnorRogers opened 9 months ago

KonnorRogers commented 9 months ago

Hi there! I was wondering if there's any way to define a type alias with Yard.

For example in JSDOC i can use @typedef to define a reusable type. Is this possible with Yard?

Example:

# @​typedef [String, nil] NullableString

class MyClass
  # @​param nullOrStr [NullableString]
  def initialize(nullOrStr)
     @​nullOrStr = nullOrStr
  end
end

Thank you for your time! I tried searching through the docs and other issues but couldn't find anything.

I have read the Contributing Guide.