Skip to Content

Changes for page EOModelDoc

Last modified by Theodore Petrosky on 2012/02/11 13:36
From version 45.1
edited by pierce
on 2009/01/19 18:06
Change comment: There is no comment for this version
To version 48.1
edited by David Avendasora
on 2011/05/25 13:09
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.pierce
1 +XWiki.avendasora
Content
... ... @@ -12,7 +12,7 @@
12 12  
13 13  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.
14 14  
15 -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.
15 +On the WOLips side, from version 3.3.x, [[Entity Modeler>>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.
16 16  
17 17  == Future Plans ==
18 18  
... ... @@ -20,10 +20,10 @@
20 20  
21 21  == Download and Example Output ==
22 22  
23 -[[Download EOModelDoc jar>>http://webobjects.mdimension.com/wolips/eomodeldoc-latest.jar]]
23 +[[Download EOModelDoc jar>>http://webobjects.mdimension.com/wolips/latest/eomodeldoc.jar]]
24 24  
25 25  This is an example of the current state of eomodeldoc (the default templates are not done, but it will give you an idea of what it can do). The templates are all Velocity-based, and you can override them with custom versions. This was run in the BugTracker project folder. This model does not have documentation added to it with the new Entity Modeler yet, so it looks a little more bare than it would if it was documented properly. I'll probably document it just to have a full example to show.
26 -[[View Example Output>>http://webobjects.mdimension.com/wolips/eomodeldoc_example/]]
26 +[[View Example Output>>http://webobjects.mdimension.com/wolips/support/eomodeldoc_example/]]
27 27  
28 28  == Usage ==
29 29