Skip to main content


Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Remote Application Platform (RAP) » JavaScript documentation
JavaScript documentation [message #542834] Sat, 26 June 2010 14:55 Go to next message
Philipp Leusmann is currently offline Philipp LeusmannFriend
Messages: 36
Registered: July 2009
Member
Hi all,

is there any API-doc of the qooxdoo version used in RAP and of the RAP
classes available in JavaScript like org.eclipse.swt.WidgetManager ?

I found http://api.qooxdoo.org/ , but this is for Qooxdoo 1.1 .

Regards,
Philipp
Re: JavaScript documentation [message #542951 is a reply to message #542834] Sun, 27 June 2010 20:45 Go to previous messageGo to next message
Ralf Sternberg is currently offline Ralf SternbergFriend
Messages: 1313
Registered: July 2009
Senior Member

Hi,

RAP uses a subset of qoodoo 0.7.4. The API doc can be found at

http://demo.qooxdoo.org/0.7.4/apiviewer/

Regards, Ralf

Philipp Leusmann wrote:
> Hi all,
>
> is there any API-doc of the qooxdoo version used in RAP and of the RAP
> classes available in JavaScript like org.eclipse.swt.WidgetManager ?
>
> I found http://api.qooxdoo.org/ , but this is for Qooxdoo 1.1 .
>
> Regards,
> Philipp
Re: JavaScript documentation [message #542953 is a reply to message #542951] Sun, 27 June 2010 21:26 Go to previous messageGo to next message
Philipp Leusmann is currently offline Philipp LeusmannFriend
Messages: 36
Registered: July 2009
Member
Thanks, Ralf.
Wouldn't it be possible to integrate all a RAP-Javascript-Classes in
such an API-Documentation? Ain't there a script which generates the
qooxdoo api docs?

Would be really useful.


Regards,
Philipp


Am 27.06.10 22:45, schrieb Ralf Sternberg:
> Hi,
>
> RAP uses a subset of qoodoo 0.7.4. The API doc can be found at
>
> http://demo.qooxdoo.org/0.7.4/apiviewer/
>
> Regards, Ralf
>
> Philipp Leusmann wrote:
>> Hi all,
>>
>> is there any API-doc of the qooxdoo version used in RAP and of the RAP
>> classes available in JavaScript like org.eclipse.swt.WidgetManager ?
>>
>> I found http://api.qooxdoo.org/ , but this is for Qooxdoo 1.1 .
>>
>> Regards,
>> Philipp
Re: JavaScript documentation [message #543089 is a reply to message #542953] Mon, 28 June 2010 11:20 Go to previous messageGo to next message
Stefan   is currently offline Stefan Friend
Messages: 316
Registered: July 2009
Senior Member
Good idea - I fully agree. However, the question is if the qx-API is
really a public API (with the same restrictions as the Java API
regarding compatibility). AFAIK, all JS-API is considered as internal -
right?

Regards,
Stefan.

Philipp Leusmann schrieb:
> Thanks, Ralf.
> Wouldn't it be possible to integrate all a RAP-Javascript-Classes in
> such an API-Documentation? Ain't there a script which generates the
> qooxdoo api docs?
>
> Would be really useful.
>
Re: JavaScript documentation [message #543235 is a reply to message #543089] Mon, 28 June 2010 17:57 Go to previous messageGo to next message
Ralf Sternberg is currently offline Ralf SternbergFriend
Messages: 1313
Registered: July 2009
Senior Member

Stefan is right, we cannot guarantee that we stay with the current
version and subset of qooxdoo. Since we strive for making the client as
lightweight and fast as possible, we can only use qx code that is really
needed for RWT.

However, we see that custom widget developers need a reliable interface
and therefore we already discussed to establish a minimal API for custom
widgets on the client.


Regards, Ralf


Stefan Roeck wrote:
> Good idea - I fully agree. However, the question is if the qx-API is
> really a public API (with the same restrictions as the Java API
> regarding compatibility). AFAIK, all JS-API is considered as internal -
> right?
>
> Regards,
> Stefan.
>
> Philipp Leusmann schrieb:
>> Thanks, Ralf.
>> Wouldn't it be possible to integrate all a RAP-Javascript-Classes in
>> such an API-Documentation? Ain't there a script which generates the
>> qooxdoo api docs?
>>
>> Would be really useful.
>>
Re: JavaScript documentation [message #543245 is a reply to message #543235] Mon, 28 June 2010 19:03 Go to previous message
Philipp Leusmann is currently offline Philipp LeusmannFriend
Messages: 36
Registered: July 2009
Member
Since RAP only uses a subset of qooxdoo, it is even more important to
provide an API-Doc on what is available for widget developer.
I guess, qooxdoo is using some kind of JavaDoc-like annotations to
compile the API-dok, so probably it wouldn't be too hard to create a
RAP-ApiDoc containing all the docs from the qooxdoo subset and also from
the RAP classes.

Is anybody from the qooxdoo-team reading this thread and may provide any
additional information on how the APIdocs are compiled?

Regard,
Philipp

Am 28.06.10 19:57, schrieb Ralf Sternberg:
> Stefan is right, we cannot guarantee that we stay with the current
> version and subset of qooxdoo. Since we strive for making the client as
> lightweight and fast as possible, we can only use qx code that is really
> needed for RWT.
>
> However, we see that custom widget developers need a reliable interface
> and therefore we already discussed to establish a minimal API for custom
> widgets on the client.
>
>
> Regards, Ralf
>
>
> Stefan Roeck wrote:
>> Good idea - I fully agree. However, the question is if the qx-API is
>> really a public API (with the same restrictions as the Java API
>> regarding compatibility). AFAIK, all JS-API is considered as internal -
>> right?
>>
>> Regards,
>> Stefan.
>>
>> Philipp Leusmann schrieb:
>>> Thanks, Ralf.
>>> Wouldn't it be possible to integrate all a RAP-Javascript-Classes in
>>> such an API-Documentation? Ain't there a script which generates the
>>> qooxdoo api docs?
>>>
>>> Would be really useful.
>>>
Previous Topic:dynamically update widget from differnt project in eclipse
Next Topic:BrowserFunction in custom widget
Goto Forum:
  


Current Time: Mon Feb 26 19:47:38 GMT 2024

Powered by FUDForum. Page generated in 0.02384 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software

Back to the top