Skip to Content

Changes for page EOModelDoc

Last modified by Theodore Petrosky on 2012/02/11 13:36
From version 54.1
edited by Theodore Petrosky
on 2012/02/11 13:36
Change comment: Renamed back-links.
To version 51.1
edited by Pascal Robert
on 2012/02/11 13:36
Change comment: Migrated to Confluence 5.3

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,1 @@
1 -WOL.Home.WebHome
1 +Home
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.tedpet
1 +XWiki.probert
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>>url:http://www.rubicode.com/Software/EOReporter/||shape="rect"]] (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>>doc:documentation.Home.Entity Modeler.WebHome]] 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>>doc:documentation.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  
... ... @@ -29,9 +29,7 @@
29 29  
30 30  The command line syntax of for EOModelDoc:
31 31  
32 -{{code language="none"}}
33 -java -jar eomodeldoc.jar -output /path/to/output/folder [-model /path/to/model.eomodeld]* [-modelgroup /path/to/working/dir] [-templates /path/to/templates] [-entityURLTemplate "http://domain/path/to/JavaDocs/$entity.classNamePath.html
34 -{{/code}}
32 +{{code language="none"}}java -jar eomodeldoc.jar -output /path/to/output/folder [-model /path/to/model.eomodeld]* [-modelgroup /path/to/working/dir] [-templates /path/to/templates] [-entityURLTemplate "http://domain/path/to/JavaDocs/$entity.classNamePath.html{{/code}}
35 35  
36 36  |=(((
37 37  Parameter
... ... @@ -103,7 +103,8 @@
103 103  
104 104  There is no Ant task (yet) for EOModelDoc. You can run it with an {{code language="none"}}java{{/code}} task following this pattern:
105 105  
106 -{{code 0="xml"}}<java jar="/path/to/eomodeldoc.jar"
104 +{{code 0="xml"}}
105 +<java jar="/path/to/eomodeldoc.jar"
107 107   fork="true"
108 108   maxmemory="256m">
109 109   <arg value="-output" />
... ... @@ -114,7 +114,8 @@
114 114   <arg value="/path/to/templates" />
115 115   <arg value="-entityURLTemplate" />
116 116   <arg value="http://whatever?$${entity.classNamePath}.html" />
117 -</java>{{/code}}
116 +</java>
117 +{{/code}}
118 118  
119 119  {{code 0="xml"}}
120 120  
... ... @@ -162,7 +162,7 @@
162 162  
163 163  {{/code}}
164 164  
165 -See the [[EOGenerator template documentation>>doc:WOL.Home.EOGenerator.EOGenerator Templates and Additions.WebHome]] documentation for information on customizing these templates. The {{code language="none"}}-templates{{/code}} path only needs to point the the templates that you have changed. If any templates are not found on that path, the defaults from the jar are used.
165 +See the [[EOGenerator template documentation>>doc:EOGenerator Templates and Additions]] documentation for information on customizing these templates. The {{code language="none"}}-templates{{/code}} path only needs to point the the templates that you have changed. If any templates are not found on that path, the defaults from the jar are used.
166 166  
167 167  The templates and their function are:
168 168