How can I create Ruby documentation with a hierarchical view of classes? -
i new documenting ruby code.
i have tried both rdoc , yard. work fine, uncomfortable how list classes (alphabetically).
i have class action, subclasses run, jump, duck, etc. have class character classes hero , monster.
rdoc , yard give me this:
- action
- character
- duck
- hero
- jump
- monster
- run
but frankly, makes no sense. i'd rather have this:
- action
- duck
- jump
- run
- character
- hero
- monster
or write own categories:
- "actionable stuff"
- action
- duck
- jump
- run
- "interactive stuff"
- character
- hero
- monster
but not plain alphabetical list. how can achieve in either rdoc or yard? if not, there other ruby documenting tool may provide kind of view?
you need generator happen.
the problem rdoc (and yard, assume) create tree out of documentation , program used produce final html output (a generator).
there few rdoc generators, it's possible you'll have write own -- there's fivefish, , use own projects, don't think addresses problem.
ps: if create new generator, please post everywhere -- it's hard find them! :(
Comments
Post a Comment