Create api doc for model associations

senchalabs / jsduck

Simple JavaScript Duckumentation generator.

http://docs.sencha.com/

GNU General Public License v3.0

1.5k stars 238 forks source link

Create api doc for model associations #187

Open marcojahn opened 12 years ago

marcojahn commented 12 years ago

It would be nice to have association dependencies automatically created within API doc.

Currently we have implemented a custom tag but I think it would be nice to have associations documented in an automatic way

In my custom tag implementation it looks like this (output):

Associations

hasMany AssociationName
package.App.model.AssociationClassName

nene commented 12 years ago

Related to #113 and somewhat to #184.

I'll think about it after the new JavaScript parser gets fully integrated.

TMcKinley commented 11 years ago

This would be very beneficial for us as well. We have one associations array which contains multiple HasMany configurations and it would be very nice to be able to comment each one.

valioDOTch commented 10 years ago

+1 I'd like to see a proper Model association documentation handling as well.

Even more beneficial would be a graphical representation of all models and their associations (e.g. via ERM or UML graph as SVG)