Re: Documenting the EO Model
Re: Documenting the EO Model
- Subject: Re: Documenting the EO Model
- From: Benjamin Steiner <email@hidden>
- Date: Thu, 12 Nov 2015 09:02:46 +0100
Thank you very much for all the your advice. I think it will be quite useful for our project.
@Chuck: Thanks for the eogen template, we actually tried to generate the JavaDoc from the Docs-Section in the Entity Modeler, but we didn’t know exactly how to do that
@Paul Hoadley: The EOModelDoc still works, but I have no idea where or how to get the source.
Beni
> On 06 Nov 2015, at 19:44, Chuck Hill <email@hidden> wrote:
>
> I¹Ve used EOModelDoc. Below are some Ant fragments to get you started. I
> am also attaching a eogen template showing how to drive the documentation
> from the EOModel into the classes where JavaDoc and you IDE will pick it
> up. I find that generally more useful.
>
> Chuck
>
>
> <!-- Generate documentation from EOModels -->
> <target name="eomodeldoc" depends="setProps">
> <java jar="EOModelDoc/eomodeldoc.jar"
> fork="true"
> maxmemory="256m">
> <arg value="-output" />
> <arg value="../../Documentation/Generated/EOModelDocs" />
> <arg value="-model" />
> <arg value="CadreCore/Resources/CadreEO.eomodeld" />
> <arg value="-model" />
> <arg value="HHSecurity/Resources/HHSecurityEO.eomodeld" />
> <arg value="-model" />
> <arg
> value="Frameworks/GVCGenericObjects.framework/Resources/GVCGenericObjects.e
> omodeld" />
> <arg value="-model" />
> <arg value="CadrePrototypes/Resources/CadrePrototypes.eomodeld" />
> <arg value="-templates" />
> <arg value="EOModelDoc" />
> <arg value="-entityURLTemplate" />
> <arg value="../../../JavaDocs/$${entity.classNamePath}.html" />
> </java>
> </target>
>
>
>
> <!-- Test for upcoming version of WOLips (which is here but needs to be
> verified -->
> <target name="eomodeldocnew" depends="setProps">
> <java jar="EOModelDoc/eomodeldocnew.jar"
> fork="true"
> maxmemory="256m">
> <arg value="-output" />
> <arg value="../../Documentation/Generated/EOModelDocs" />
> <arg value="-modelgroup" />
> <arg value="CadreCore" />
> <arg value="-templates" />
> <arg value="EOModelDoc" />
> <arg value="-entityURLTemplate" />
> <arg value="../../../JavaDocs/$${entity.classNamePath}.html" />
> </java>
> </target>
>
>
>
>
>
> On 2015-11-06, 12:49 AM,
> "webobjects-dev-bounces+chill=email@hidden on behalf of
> Benjamin Steiner"
> <webobjects-dev-bounces+chill=email@hidden on behalf of
> email@hidden> wrote:
>
>> Hi list,
>>
>> We are currently designing a quite complex EO Model, and there¹s a lot to
>> be documented. Does anyone have some advice on how to approach that on a
>> large scale or is anyone using some Tools to do it?
>> I¹ve heard of program called ³EO Model Doc², but i don¹t know how to get
>> it or if it¹s even still working.
>>
>> thanks for any advice
>> beni
>> _______________________________________________
>> Do not post admin requests to the list. They will be ignored.
>> Webobjects-dev mailing list (email@hidden)
>> Help/Unsubscribe/Update your Subscription:
>> om
>>
>> This email sent to email@hidden
>
> <HHBaseClass.eotemplate>
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Webobjects-dev mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden