[OpenAjaxIDE] parameters and return values of functions that are parameters

Jon Ferraiolo jferrai at us.ibm.com
Tue Sep 16 23:23:31 PDT 2008


I realize that Kevin's proposal allows for easy definition of function
parameters within a single line, such as:

@param {Function(String)} paramName

but is there a way to better leverage what already exists for describing
functions in JSDoc and/or ScriptDoc, such that everything about the
function parameter, including return types, can be described? Perhaps
something like this:

@param {Function} func1 descriptive text about callback function
@@param {String} arg1 descriptive text about arg1
@@return {Object} descriptive text about the return value

Then in XML we could represent it as:

<parameter datatype="Function" name="func1">
__<description>descriptive text about callback function</description>
__<parameters>>
____<paramater datatype="String" name="arg1">
______<description>descriptive text about arg1</description>
____</paramater>
__</parameters>>
__<returnType datatype="Object">
____<description>descriptive text about the return value</description>
__</returnType>
</parameter>

Where nesting of parameter elements is only allowed with Function
parameters.

Jon



                                                                           
             Lori Hylan-Cho                                                
             <lorihc at aptana.co                                             
             m>                                                         To 
             Sent by:                  "ide at openajax.org"                  
             ide-bounces at opena         <ide at openajax.org>                  
             jax.org                                                    cc 
                                                                           
                                                                   Subject 
             09/16/2008 01:48          [OpenAjaxIDE] parameters and return 
             PM                        values of functions that are        
                                       parameters                          
                                                                           
                                                                           
                                                                           
                                                                           
                                                                           
                                                                           




http://www.scriptdoc.org/forums/viewtopic.php?t=931

-----------------------------------------------------------------------
Lori Hylan-Cho             Ajax Wrangler        Aptana, Inc.
lorihc at aptana.com          650.207.1905         avocadoh (Y!/AIM/GTalk)
 _______________________________________________
IDE mailing list
IDE at openajax.org
http://openajax.org/mailman/listinfo/ide
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://openajax.org/pipermail/ide/attachments/20080916/179f499c/attachment.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/ide/attachments/20080916/179f499c/attachment.gif 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: pic04276.gif
Type: image/gif
Size: 1255 bytes
Desc: not available
Url : http://openajax.org/pipermail/ide/attachments/20080916/179f499c/attachment-0001.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/ide/attachments/20080916/179f499c/attachment-0002.gif 


More information about the IDE mailing list