Skip to Content

Changes for page EOModelDoc

Last modified by Theodore Petrosky on 2012/02/11 13:36
From version 31.1
edited by Chuck Hill
on 2008/07/31 14:22
Change comment: There is no comment for this version
To version 32.1
edited by Chuck Hill
on 2008/07/31 14:27
Change comment: Edits

Summary

Details

Page properties
Content
... ... @@ -11,4 +11,32 @@
11 11  == Download and Example Output ==
12 12  
13 13  [[Download EOModelDoc jar>>http://webobjects.mdimension.com/wolips/eomodeldoc.jar]]
14 +
15 +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.
14 14  [[View Example Output>>http://webobjects.mdimension.com/wolips/eomodeldoc_example/]]
17 +
18 +== Usage ==
19 +
20 +Still working on all the model loaders, but you should be able to do
21 +
22 +java --jar eomodeldoc.jar --model /path/to/model.eomodeld --output /tmp/
23 +eomodeldoc
24 +(will load all the models in the modelgroup based on your eclipse or
25 +IDEA project files ..... allegedly ... still working the kinks out on
26 +this)
27 +or
28 +
29 +java --jar eomodeldoc.jar --modelgroup /path/to/project --output /tmp/
30 +eomodeldoc
31 +(i haven't tried that one yet)
32 +
33 +or
34 +
35 +java --jar eomodeldoc.jar --output /tmp/eomodeldoc
36 +from inside your project
37 +
38 +Tthe usage syntax of the eomodeldoc.jar:
39 +
40 +[[mbp:~~]] th% java --jar eomodeldoc.jar
41 +eomodeldoc --output /path/to/output/folder [[-model pathtomodel.eomodeld]]** [[-modelgroup pathtoworkingdir]] [[-templates pathtotemplates]]
42 + **