Received-SPF: pass
 receiver=post.selbstdenker.com; client-ip=212.227.17.22; envelope-from=rasc@gmx.de
From: Ralf Schuchardt <rasc@gmx.de>
To: "\"WebObjects & WOnder Development\"" <webobjects-dev@wocommunity.org>
Subject: Re: [WO-DEV] How can I access EOEntity userInfo documentation  with
  EOGenerator?
Date: Tue, 14 May 2024 14:41:19 +0200
Message-ID: <56AAF02A-BA36-418C-9102-085C0ED74656@gmx.de>
In-Reply-To: <list-32487706@post.selbstdenker.com>
References: <list-32487706@post.selbstdenker.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
UI-OutboundReport: notjunk:1;M01:P0:AyQyan2hQ1I=;SDIQ1v4B+bnDs5I45pf6Gl8xfEN
 sfl99SoXIbyIl3vz7iXiK5UyLMP/u5brSWcKaK6i+rycRxZ5MoCvllSv0BGNpbPJBhksnW9CV
 ua+hP8ZP/ZtExAtFRmvFRZUcAHv3G4/9P5RnXnc3M35NysHlyYESMQ+LIna7OfsqwWwQGcCdR
 fpLVCSO+t/P3cHfJppyx1R5BrBXnktHAUHlaFPNwB+4uxozuanAqRskB5IQx8KASuZwO/GvbX
 66y64UL1y4ttrNzXrHIqVU++DN+7A2hZK7WXnwlIQiAtt95+cR7c1XnYE37tGFiPS9Vn1qAgq
 T5XESHgoGKc7RzdtS9cyt4HoW3/AeK4Ebyt/UHeGxnxDfY0k4NYuUNF7kv9sCrt+GZpCdaI5q
 0Kc/o1E866oKzxS+aWIPmQarSOTuZzVJlWxiQoLTNx145BabET2J9VMzrcNn43016MH6SOpUx
 gQEVTY8MwJ7kjcmX6e6ZO48qj+GQoNSiz3OymBEIuXAN+lcGNMrKs/dYmmcc6qhfD25/LdUhu
 gvS07SMc5Jp7sffFt5mGvWu8lM9svCbPqPnfuPYO8vq47FqUxirgFEYjqsRDhtiDjXquIpXee
 pQCwNrhUK1wbKhWeATNYwY1/QjktGxi7u5u9j1Kg2699dGVY0WtarpCPlflfqI+nL9BRpBjHV
 wiJUPeh3fpX2JbLKvw8+p1hKxiLntEuJApakvGZMn2RqQj2ZsXlGfcYM9M1g/uvpY/VEIZzkh
 hsaaWdkvvAC2rBmMWDa0S7M8CoOf25ZknUmhaFIljiNrNHZ8iv7Rs0nJZUFJVbSqTjxf0sAS3
 7XTJDugK9MfJ82HKXUe13CN1fRvMKfgA+/F/DmPDeitNo=

On 12 May 2024, at 8:59, Markus Ruggiero (rucotec) wrote:

> I can put the comments into _MyClass.java and MyClass.java. Once EOGen =
has run there will not be any updates to MyClass.java anymore. What if I =
update the documentation? The updated doc goes into the regenerated _MyCl=
ass.java but is NOT reflected in MyClass.java. The javadoc {@inheritDoc} =
only works for stuff _inside_ the class definition but not for the class =
 documentation itself.
>
> Do you know of any way to make hovering over MyClass in Eclipse show th=
e combined javadoc from _MyClass and MyClass?
>
> The conceptual documentation of an entity clearly goes into _MyClass an=
d additional implementation specific documentation should go into MyClass=
=2E But often I need to see the conceptual documentation of MyClass. Of c=
ourse I can command-click MyClass to open MyClass.java where I can hover =
over the super class and see the doc but this =E2=80=9Cmesses up my menta=
l editing context=E2=80=9D and I lose track where I was and where to go b=
ack to.
>
> Any idea?

I would open the conceptual documentation either as javadoc generated API=
 page in a browser, or in the javadoc view in Eclipse. For example, open =
the javadoc for _MyClass with F2, then click on the @-Symbol to open the =
javadoc view (and disable the automatic linking between selection and jav=
adoc view).

Ralf

>
> ---markus---
>> Markus Ruggiero (rucotec) schrieb am 11. May 2024, um 14:54 Uhr:
>>
>> When creating documentation for an entity in the Documentation tab in =
EntityModeler the resulting doc is put into the userInfo dictionary. How =
can I access this with EOGenerator?
>>
>> userInfo =3D {
>> "_EntityModeler" =3D {
>> documentation =3D "doc for EMRTreatmentStep\n<ul>\n\t<li>a list entry<=
/li>\n</ul>";
>> };
>> };
>>
>> Tried different KV-paths in the template file but failed whenever I ex=
plicitly used the key =E2=80=9C_EntityModeler=E2=80=9D with/out =E2=80=9C=
_=E2=80=9D, with/out capital =E2=80=9CE=E2=80=9D. Using =E2=80=9C_=E2=80=9D=
 results in a syntax error during generation.
>>
>> Accessing the user info dict itself works
>>
>> Using
>> ${entity.userInfo}
>>
>> results in
>> {_EntityModeler=3D{documentation=3Ddoc for EMRTreatmentStep
>> <ul>
>> <li>a list entry</li>
>> </ul>}}
>>
>> Which is great so far but two key too high in the key path.
>> However going deeper only dumps the given path itself into the result
>> ${entity.userInfo.entityModeler}
>>
>> results in
>> ${entity.userInfo.entityModeler}
>>
>> I expect this to result in something like
>> {documentation=3Ddoc for EMRTreatmentStep
>> <ul>
>> <li>a list entry</li>
>> </ul>}
>>
>> Seems like EOGenerator explicitly ignores the key =E2=80=9C_EntityMode=
ler=E2=80=9D
>>
>> I can put my own javaDoc key into the user info dict, this works, but =
the text input field in WOLips EntityModeler is way too small in the user=
Info editor.
>> What is the documentation good for if I cannot access it?
>>
>> Any ideas?
>>