search

lsegal / yard

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

@!group / @!endgroup doesn't work on constants #610

Closed NullVoxPopuli closed 11 years ago

NullVoxPopuli commented 11 years ago

example -> 

# @!group status

# @api public
UNPUBLISHED = 0
# @api public
PUBLISHED = 1
# @api public
# final - accepted
ACCEPTED = 2
# @api public
# straight up declined
# @api public
DECLINED = 3
# @api public
# waiting for more information
ACCEPTED_PENDING = 4
# @api public
# errors are less than 0
# esign document generation failed - proposal publishing cancelled
ESIGN_FAILURE = -1
# @api public
# waiting for esignature service to finish before publishing
ESIGN_DOCUMENT_IN_PROGRESS = 5

# @!endgroup status

result => result

an example of where this might be useful is where a group of constants apply to a single attribute on the object

lsegal commented 11 years ago

Constants don't (yet?) support grouping in the summary listing.

Unfortunately this feature just won't be prioritized due to lack of time/resources. If you want to help us by adding support for groups in the constant listing, I would accept such a patch.