How to use Yard to document rails enum type

Question

I have an ActiveRecord class similar to this:

class User < ActiveRecord::Base

  # How do I document this?
  enum status [:registering, :active, :suspended, :deleted]
end

status attribute is used to build a state machine. How do I document that line of code using yard? The documentation needs to contain explanation of status attribute and all it's possible states.

score 7 · Answer 1 · answered Nov 08 '15 at 19:03

7

Just list all options as comma separated list.

class User < ActiveRecord::Base

  # @!attribute [rw] status
  #   @return [:registering, :active, :suspended, :deleted]
  enum status [:registering, :active, :suspended, :deleted]
end

If you are not sure about type definition, you may consult with YARD Type Parser:

answered Nov 08 '15 at 19:03

Tema Bolshakov

1,128
8
14

Bounty awarded to you for lack of a better answer ;) – Favourite Onwuemene Nov 11 '15 at 00:16
It returns string instead of symbol. – ypresto Jan 24 '17 at 11:20

score 6 · Answer 2 · edited Feb 16 '17 at 20:01

6

class User < ActiveRecord::Base

  # @attr [Enumerable<Symbol>] status
  enum status [:registering, :active, :suspended, :deleted]
end

edited Feb 16 '17 at 20:01

Community

1
1

answered Nov 06 '15 at 19:43

John Pollard

3,729
3
24
50

How to use Yard to document rails enum type

2 Answers2