CODEWITHSUNDEEP
rubyyard
Nikita Fedyashev
Nikita Fedyashev

Reputation: 19048

YARD - how to document @!method YARD on class level rather than instance level?

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.

Upvotes: 1

Views: 606

Answers (2)

Stefan
Stefan

Reputation: 114218

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

See Documenting Custom DSL Methods

Upvotes: 1

Nikita Fedyashev
Nikita Fedyashev

Reputation: 19048

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

Upvotes: 0

Related Questions