feature request: @relation

hi!

Just an idea or feature request for further development of the amazing
jsdoc-toolkit:

I think it would be a nice feature to have a @relation tag, which helps you
to describe the relation from one "class" to another by specifying the
cardinality. For example there is a class "car" and a class "wheel" and in
car.js you can say:

@relation {1:n} Wheel

or perhaps even stronger in (min,max)-notation

@relation {(0,4):(0,1)} Wheel

With this declaration it would be possible to provide a relation overview
in each class documentation and for future use it might even be possible to
extract entity-relationship diagrams out of jsdoc-toolkit (how _nice_ would
that be? ;)).

At the moment I'm documenting a JavaScript object API with jsdoc-toolkit
and so this idea popped up right before my eyes.

In the case that there already is a related feature, which makes it
possible to describe relationships, please apologize my ignorance and move
this ticket to the almighty trash bin, thanks.

best regards,
Micha

Original issue reported on code.google.com by micha.mi...@gmail.com on 12 Feb 2009 at 12:52

swallowzhang / jsdoc-toolkit

feature request: @relation #204