Use @option for options Hash documenting?

sfcgeorge / yard-contracts

YARD Plugin for Automatic Param Docs from Contracts.

MIT License

26 stars 3 forks source link

Use @option for options Hash documenting? #4

Open sfcgeorge opened 9 years ago

sfcgeorge commented 9 years ago

YARD seems to have an @option tag for documenting options Hashes, should that be used? Currently the full options hash is used in @param which can be a bit messy. We could loop through it and break out @option instead.