Improved documentation

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@21741 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
CaS 2005-09-23 14:16:31 +00:00
parent b6adfd8cf9
commit 98cda7dbab
2 changed files with 19 additions and 1 deletions

View file

@ -446,6 +446,24 @@
* method call (with timeout), or an asynchronous call in which the
* call completion is handled by a delegate.
* </p>
* <p>You may also use the class to implement an XMLRPC server, by calling
* the -parseMethod:params: method to parse the data POSTed to your server,
* and -buildResponseWithParams: (or -buildResponseWithFaultCode:andString:)
* to produce the data to be sent back to the client.
* </p>
* <p>In order to simply make a synchronous XMLRPC call to a server, all
* you need to do is write code like:
* </p>
* <example>
* GSXMLRPC *server = [[GSXMLRPC alloc] initWithURL: @"http://server/path"];
* id result = [server makeMethodCall: name params: p timeout: 30];
* </example>
* <p>Saying that you want to call the specified method ('name') on the server,
* passing the parameters ('p') and with a 30 second timeout.<br />
* If there is a network or http-level error or a timeout, the result will be
* an error string, otherwise it will be an array (on success) or a dictionary
* containing the fault details.
* </p>
*/
@interface GSXMLRPC : NSObject <NSURLHandleClient>
{

View file

@ -72,7 +72,7 @@
- (BOOL) argumentsRetained;
- (void) retainArguments;
#if OS_API_VERSION(GS_API_NONE,GS_API_NONE) && GS_API_VERSION(011201,GS_API_LATEST)
#if OS_API_VERSION(GS_API_NONE,GS_API_NONE) && GS_API_VERSION(011101,GS_API_LATEST)
- (BOOL) targetRetained;
- (void) retainArgumentsIncludingTarget: (BOOL)retainTargetFlag;
#endif