[OpenAjaxGadgets] API jsdoc and interfaces

[Jon Ferraiolo]

Hi Howard,
Thanks for doing this! I haven't done a deep review of the API descriptions
that you have done, but at the surface level things look very good. This
certainly represents great progress on an editorial issue and hammering out
technical details.

I copied/pasted all of your API descriptions into the fresh new "Widget
APIs" chapter in the metadata spec:

*
http://www.openajax.org/member/wiki/OpenAjax_Metadata_1.0_Specification_Widget_APIs

I noticed one typo, where you had getProxyUrl() in the file twice.
Obviously, the second occurrence was supposed to be makeRequest(). I made a
minor change to the open source before copying into the spec.

I'll schedule a Gadgets phone call for this Monday to talk about the issues
you raised.

Thanks once again. This helps A LOT!

Jon




                                                                           
             Howard Weingram                                               
             <weingram at tibco.c                                             
             om>                                                        To 
             Sent by:                  "gadgets at openajax.org"              
             gadgets-bounces at o         <gadgets at openajax.org>              
             penajax.org                                                cc 
                                                                           
                                                                   Subject 
             03/31/2009 05:45          [OpenAjaxGadgets] API jsdoc and     
             PM                        interfaces                          
                                                                           
                                                                           
                                                                           
                                                                           
                                                                           
                                                                           




Hi everyone.

I have checked in a file in the gadgets/src directory:

        oawidget.js

This contains the interface definitions and JSDoc comments for the
following, without implementation code, so that we can see them,
discuss them and fix them without waiting for the implementation
code changes to finish in widget.js.

In the JSDoc comments, I identify several potential issues:

    * Errors are currently undefined.

    * The dimensions operations are currently synchronous/blocking,
        whereas Hub communication is asynchronous. Functions
        related to dimensions probably need callbacks to
        handle the responses.

The interfaces defined in oawidget.js are as follows:

    OpenAjax.widget.Error

        Standard errors should be defined here.

    OpenAjax.widget.Event

        Event object.
        JSDoc comments only (no code)

    OpenAjax.widget.Dimensions

        Dimensions object with width and/or height
        JSDoc comments only (no code)

    OpenAjax.widget.Widget

        Widget implementation object defined in jsClass.
        JSDoc comments only (no code)

    OpenAjax.widget.WidgetAdapter

        Interface definition for widget.OpenAjax

I have not yet defined params objects for the various functions that
require
them.

Please take a look and comment.

Regards,
Howard


--
Howard Weingram      650.846.1000
Principal Architect  TIBCO Software Inc.

TIBCO PageBus(TM) delivers ultra-lightweight
publish-subscribe messaging for mash-ups.
Learn more at http://www.pagebus.org

_______________________________________________
gadgets mailing list
gadgets at openajax.org
http://openajax.org/mailman/listinfo/gadgets
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://openajax.org/pipermail/gadgets/attachments/20090401/1c6b397d/attachment-0001.html 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: graycol.gif
Type: image/gif
Size: 105 bytes
Desc: not available
Url : http://openajax.org/pipermail/gadgets/attachments/20090401/1c6b397d/attachment-0003.gif 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: pic08382.gif
Type: image/gif
Size: 1255 bytes
Desc: not available
Url : http://openajax.org/pipermail/gadgets/attachments/20090401/1c6b397d/attachment-0004.gif 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: ecblank.gif
Type: image/gif
Size: 45 bytes
Desc: not available
Url : http://openajax.org/pipermail/gadgets/attachments/20090401/1c6b397d/attachment-0005.gif