Wiki source code of EOModelDoc
Version 30.1 by Chuck Hill on 2008/07/31 14:22
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | == Overview == | ||
| 2 | |||
| 3 | EOModelDoc is a command line tool to generate HTML documentation of a set of EOModels. It is a replacement for [[EOReporter>>http://www.rubicode.com/Software/EOReporter/]] (which will not work on Leopard and newer releases of OS X). EOModelDoc was funded by the Apple iTunes Store and released to the community. | ||
| 4 | |||
| 5 | On the WOLips side, from version 3.3.x, [[Entity Modeler>>Using Entity Modeler]] has a Documentation tab on all of the elements of a model that lets you record HTML documentation for your model, entities, attributes, etc. There is even an HTML preview. You can then run eomodeldoc to produce documentation much like javadoc for your model. | ||
| 6 | |||
| 7 | == Future Plans == | ||
| 8 | |||
| 9 | From Mike Schrag: //There's not a nice build process for this one either, yet, because it includes all of the eclipse dependencies in the single jar. Eventually I'll make this nicer and include it actually inside of Eclipse. There are also modifications to the ERNeutralLook coming soon that will display popup help for you models based on the model documentation.// | ||
| 10 | |||
| 11 | == Download and Example Output == | ||
| 12 | |||
| 13 | [[Download EOModelDoc jar>>http://webobjects.mdimension.com/wolips/eomodeldoc.jar]] | ||
| 14 | [[View Example Output>>http://webobjects.mdimension.com/wolips/eomodeldoc_example/]] |