By default, such methods are created on the instance level from what I see. How to document class/static level methods instead?
I checked https://www.rubydoc.info/gems/yard/file/docs/Tags.md#method but it wasn't very clear.
2 Answers
This can be adjusted via @!scope which can be either class or instance:
class Foo
# @!scope class
#
# @!method bar
# @return [Bar] enum scope
# @!method baz
# @return [Baz] enum scope
end
Workaround using blank eigen-class seems to work fine but perhaps someone knows a more idiomatic and clean way of doing it?
class Foo < ActiveRecord::Base
class << self
# @!method bar
# @return [Bar] enum scope
# @!method baz
# @return [Baz] enum scope
end
enum status: FooStatuses
end
Related