Menu
▾
▴
Re: [staf-users] STAF Javadocs
|
From: Sharon L. <lu...@us...> - 2006-01-23 17:08:49
|
We do not provide javadocs documentation for the STAF Java APIs as the STAF Java source code is not commented for Javadocs. As you've seen, we document the contents of the STAFServiceInterfaceLevel30.RequestInfo class in Appendix A of the STAF Service Developer's Guide and document information about the STAFCommandParseResult class in section "5.1.3 Accepting Requests Phase", sub-sections "Parse the Request" and "Get Options Values and Resolve Variables in Option Values". You can also look at the source (e.g. staf/lang/java/service/STAFCommandParseResult.java). However, you'll see that the comments within the class are not provided in a javadocs format. You are welcome to run javadocs on the staf/lang/java directory, but you won't get additional comments about the classes/methods/instance variables, as comments are not provided in a javadocs format within the source code. Note that STAF provides support for many different programming languages (e.g. C/C++, Perl, Java, etc.) and we haven't yet utilized documentation utilities provided by each particular language. You can open a feature request via http://staf.sourceforge.net to request that javadocs to be provided for the STAF Java service classes, etc. -------------------------------------------------------------- Sharon Lucas IBM Austin, lu...@us... (512) 838-8347 or Tieline 678-8347 Cameron McAllister <C.M...@uk...> Sent by: sta...@li... 01/23/2006 09:05 AM To Sharon Lucas/Austin/IBM@IBMUS cc sta...@li... Subject Re: [staf-users] STAF Javadocs I'll clarify what i'm working on. I am making a Service for STAF, (not STAX, sory) in Java by implementing STAFServiceInterfaceLevel30 However, for unit testing and such there are a great number of relatively undocumented classes that I wish to use, for example: com.ibm.staf.service.STAFServiceInterfaceLevel30.RequestInfo com.ibm.staf.service.STAFCommandParseResult which aren't documented in source, and would be useful to have more detailed information on usage. Cheers, Cameron. ------------------------------------------------------- This SF.net email is sponsored by: Splunk Inc. Do you grep through log files for problems? Stop! Download the new AJAX search engine that makes searching your log files as easy as surfing the web. DOWNLOAD SPLUNK! http://sel.as-us.falkag.net/sel?cmd=lnk&kid=103432&bid=230486&dat=121642 _______________________________________________ staf-users mailing list sta...@li... https://lists.sourceforge.net/lists/listinfo/staf-users |