Home » Modeling » EMF "Technology" (Ecore Tools, EMFatic, etc) » Teneo API specification online?
| Teneo API specification online? [message #114958] |
Mon, 17 March 2008 18:03  |
Eclipse User |
|
|
|
Originally posted by: schlamp.medihack.org
Is there an API specification (Javadoc) of Teneo online? I searched
elver.org and eclipse.org, but didn't find one. Did I miss something?
Kai
|
|
| |
| Re: Teneo API specification online? [message #115063 is a reply to message #114984] |
Tue, 18 March 2008 19:33  |
| Eclipse User |
|
|
|
Originally posted by: schlamp.medihack.org
Thanks for the answer, Martin. And also thanks for such a nice peace of
software. Teneo is great.
I will generate the Javadoc myself, but I think an online API reference on
your website, or an integrated one in the help system after installing the
plugin would help a lot. Me and a lot of other developers I know, like to
look at the API before installing anything to get an overview.
Best regards,
Kai
Martin Taal wrote:
> Hi Kai,
> No not really, you should get the source code (is installed automatically as
part of the sdk), the
> source code contains comments were appropriate.
> gr. Martin
> Kai Schlamp wrote:
>> Is there an API specification (Javadoc) of Teneo online? I searched
>> elver.org and eclipse.org, but didn't find one. Did I miss something?
>>
>> Kai
>>
|
|
|
| Re: Teneo API specification online? [message #115075 is a reply to message #115063] |
Tue, 18 March 2008 19:50 |
 Martin Taal
Messages: 5468
Registered: July 2009 |
Senior Member |
|
|
Hi Kai,
I understand what you mean but just to explain why I am not that javadoc focused (and why I am
afraid that the generated javadoc won't look that nice). One reason is ofcourse time... (it always
is), it is a fair amount of work to keep the javadoc in sync with the code. So therefore in the past
years I have moved away from doing javadoc. Comments in the code are easier to maintain and this
together with the code should be readable enough.
Also eclipse makes it very easy to step through the code. I have worked a lot with hibernate (which
almost has no javadoc) and I did not feel that as an obstacle as I was stepping through the code.
And as a last reason for not having a good javadoc around the api is that the api of Teneo should be
largely hidden for the user, there are the setEPackage, setProperties and the initialize methods of
the datastore and for the rest the user can talk to hibernate/emf.
Having said all this, nicely formatted javadoc (like the java sdk itself) can for sure be of help.
Like the javadoc with the java dateformat which has often saved me some time.
gr. Martin
Kai Schlamp wrote:
> Thanks for the answer, Martin. And also thanks for such a nice peace of
> software. Teneo is great.
> I will generate the Javadoc myself, but I think an online API reference
> on your website, or an integrated one in the help system after
> installing the plugin would help a lot. Me and a lot of other developers
> I know, like to look at the API before installing anything to get an
> overview.
>
> Best regards,
> Kai
>
>
> Martin Taal wrote:
>
>> Hi Kai,
>> No not really, you should get the source code (is installed
>> automatically as
> part of the sdk), the
>> source code contains comments were appropriate.
>
>> gr. Martin
>
>> Kai Schlamp wrote:
>>> Is there an API specification (Javadoc) of Teneo online? I searched
>>> elver.org and eclipse.org, but didn't find one. Did I miss something?
>>>
>>> Kai
>>>
>
>
>
>
--
With Regards, Martin Taal
Springsite/Elver.org
Office: Hardwareweg 4, 3821 BV Amersfoort
Postal: Nassaulaan 7, 3941 EC Doorn
The Netherlands
Tel: +31 (0)84 420 2397
Fax: +31 (0)84 225 9307
Mail: mtaal@springsite.com - mtaal@elver.org
Web: www.springsite.com - www.elver.org
|
|
|
| Re: Teneo API specification online? [message #115286 is a reply to message #115075] |
Fri, 21 March 2008 16:37 |
| Eclipse User |
|
|
|
Originally posted by: schlamp.medihack.org
Hi Martin,
thanks for the explanations and for the wonderful Teneo support here in
the newsgroup.
And you are right, the code is really good commented.
Regards,
Kai
Martin Taal wrote:
> Hi Kai,
> I understand what you mean but just to explain why I am not that javadoc
focused (and why I am
> afraid that the generated javadoc won't look that nice). One reason is
ofcourse time... (it always
> is), it is a fair amount of work to keep the javadoc in sync with the code.
So therefore in the past
> years I have moved away from doing javadoc. Comments in the code are easier
to maintain and this
> together with the code should be readable enough.
> Also eclipse makes it very easy to step through the code. I have worked a
lot with hibernate (which
> almost has no javadoc) and I did not feel that as an obstacle as I was
stepping through the code.
> And as a last reason for not having a good javadoc around the api is that
the api of Teneo should be
> largely hidden for the user, there are the setEPackage, setProperties and
the initialize methods of
> the datastore and for the rest the user can talk to hibernate/emf.
> Having said all this, nicely formatted javadoc (like the java sdk itself)
can for sure be of help.
> Like the javadoc with the java dateformat which has often saved me some time.
> gr. Martin
> Kai Schlamp wrote:
>> Thanks for the answer, Martin. And also thanks for such a nice peace of
>> software. Teneo is great.
>> I will generate the Javadoc myself, but I think an online API reference
>> on your website, or an integrated one in the help system after
>> installing the plugin would help a lot. Me and a lot of other developers
>> I know, like to look at the API before installing anything to get an
>> overview.
>>
>> Best regards,
>> Kai
>>
>>
>> Martin Taal wrote:
>>
>>> Hi Kai,
>>> No not really, you should get the source code (is installed
>>> automatically as
>> part of the sdk), the
>>> source code contains comments were appropriate.
>>
>>> gr. Martin
>>
>>> Kai Schlamp wrote:
>>>> Is there an API specification (Javadoc) of Teneo online? I searched
>>>> elver.org and eclipse.org, but didn't find one. Did I miss something?
>>>>
>>>> Kai
>>>>
>>
>>
>>
>>
|
|
| |
| Re: Teneo API specification online? [message #615928 is a reply to message #114984] |
Tue, 18 March 2008 19:33 |
Kai Schlamp
Messages: 344
Registered: July 2009 |
Senior Member |
|
|
Thanks for the answer, Martin. And also thanks for such a nice peace of
software. Teneo is great.
I will generate the Javadoc myself, but I think an online API reference on
your website, or an integrated one in the help system after installing the
plugin would help a lot. Me and a lot of other developers I know, like to
look at the API before installing anything to get an overview.
Best regards,
Kai
Martin Taal wrote:
> Hi Kai,
> No not really, you should get the source code (is installed automatically as
part of the sdk), the
> source code contains comments were appropriate.
> gr. Martin
> Kai Schlamp wrote:
>> Is there an API specification (Javadoc) of Teneo online? I searched
>> elver.org and eclipse.org, but didn't find one. Did I miss something?
>>
>> Kai
>>
|
|
|
| Re: Teneo API specification online? [message #615929 is a reply to message #115063] |
Tue, 18 March 2008 19:50 |
Martin Taal
Messages: 5468
Registered: July 2009 |
Senior Member |
|
|
Hi Kai,
I understand what you mean but just to explain why I am not that javadoc focused (and why I am
afraid that the generated javadoc won't look that nice). One reason is ofcourse time... (it always
is), it is a fair amount of work to keep the javadoc in sync with the code. So therefore in the past
years I have moved away from doing javadoc. Comments in the code are easier to maintain and this
together with the code should be readable enough.
Also eclipse makes it very easy to step through the code. I have worked a lot with hibernate (which
almost has no javadoc) and I did not feel that as an obstacle as I was stepping through the code.
And as a last reason for not having a good javadoc around the api is that the api of Teneo should be
largely hidden for the user, there are the setEPackage, setProperties and the initialize methods of
the datastore and for the rest the user can talk to hibernate/emf.
Having said all this, nicely formatted javadoc (like the java sdk itself) can for sure be of help.
Like the javadoc with the java dateformat which has often saved me some time.
gr. Martin
Kai Schlamp wrote:
> Thanks for the answer, Martin. And also thanks for such a nice peace of
> software. Teneo is great.
> I will generate the Javadoc myself, but I think an online API reference
> on your website, or an integrated one in the help system after
> installing the plugin would help a lot. Me and a lot of other developers
> I know, like to look at the API before installing anything to get an
> overview.
>
> Best regards,
> Kai
>
>
> Martin Taal wrote:
>
>> Hi Kai,
>> No not really, you should get the source code (is installed
>> automatically as
> part of the sdk), the
>> source code contains comments were appropriate.
>
>> gr. Martin
>
>> Kai Schlamp wrote:
>>> Is there an API specification (Javadoc) of Teneo online? I searched
>>> elver.org and eclipse.org, but didn't find one. Did I miss something?
>>>
>>> Kai
>>>
>
>
>
>
--
With Regards, Martin Taal
Springsite/Elver.org
Office: Hardwareweg 4, 3821 BV Amersfoort
Postal: Nassaulaan 7, 3941 EC Doorn
The Netherlands
Tel: +31 (0)84 420 2397
Fax: +31 (0)84 225 9307
Mail: mtaal@springsite.com - mtaal@elver.org
Web: www.springsite.com - www.elver.org
|
|
|
| Re: Teneo API specification online? [message #615945 is a reply to message #115075] |
Fri, 21 March 2008 16:37 |
Kai Schlamp
Messages: 344
Registered: July 2009 |
Senior Member |
|
|
Hi Martin,
thanks for the explanations and for the wonderful Teneo support here in
the newsgroup.
And you are right, the code is really good commented.
Regards,
Kai
Martin Taal wrote:
> Hi Kai,
> I understand what you mean but just to explain why I am not that javadoc
focused (and why I am
> afraid that the generated javadoc won't look that nice). One reason is
ofcourse time... (it always
> is), it is a fair amount of work to keep the javadoc in sync with the code.
So therefore in the past
> years I have moved away from doing javadoc. Comments in the code are easier
to maintain and this
> together with the code should be readable enough.
> Also eclipse makes it very easy to step through the code. I have worked a
lot with hibernate (which
> almost has no javadoc) and I did not feel that as an obstacle as I was
stepping through the code.
> And as a last reason for not having a good javadoc around the api is that
the api of Teneo should be
> largely hidden for the user, there are the setEPackage, setProperties and
the initialize methods of
> the datastore and for the rest the user can talk to hibernate/emf.
> Having said all this, nicely formatted javadoc (like the java sdk itself)
can for sure be of help.
> Like the javadoc with the java dateformat which has often saved me some time.
> gr. Martin
> Kai Schlamp wrote:
>> Thanks for the answer, Martin. And also thanks for such a nice peace of
>> software. Teneo is great.
>> I will generate the Javadoc myself, but I think an online API reference
>> on your website, or an integrated one in the help system after
>> installing the plugin would help a lot. Me and a lot of other developers
>> I know, like to look at the API before installing anything to get an
>> overview.
>>
>> Best regards,
>> Kai
>>
>>
>> Martin Taal wrote:
>>
>>> Hi Kai,
>>> No not really, you should get the source code (is installed
>>> automatically as
>> part of the sdk), the
>>> source code contains comments were appropriate.
>>
>>> gr. Martin
>>
>>> Kai Schlamp wrote:
>>>> Is there an API specification (Javadoc) of Teneo online? I searched
>>>> elver.org and eclipse.org, but didn't find one. Did I miss something?
>>>>
>>>> Kai
>>>>
>>
>>
>>
>>
|
|
|
Goto Forum:
Current Time: Sat Nov 09 05:27:21 GMT 2024
Powered by FUDForum. Page generated in 0.03914 seconds |
] 
Search
Help
Register
Login
Home
