updated documenation

This commit is contained in:
maroy 2004-12-02 01:36:06 +00:00
parent 43d01bf422
commit c0cc88833e

View file

@ -22,7 +22,7 @@
Author : $Author: maroy $ Author : $Author: maroy $
Version : $Revision: 1.1 $ Version : $Revision: 1.2 $
Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/schedulerClient/include/LiveSupport/SchedulerClient/SchedulerClientFactory.h,v $ Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/schedulerClient/include/LiveSupport/SchedulerClient/SchedulerClientFactory.h,v $
------------------------------------------------------------------------------*/ ------------------------------------------------------------------------------*/
@ -64,38 +64,35 @@ using namespace LiveSupport::Core;
* The factory to create SchedulerClientInterface objects. * The factory to create SchedulerClientInterface objects.
* *
* This object has to be configured with an XML configuration element * This object has to be configured with an XML configuration element
* called authenticationClientFactory. This element contains a child element * called schedulerClientFactory. This element contains a child element
* specifying and configuring the kind of AuthenticationClient that the * specifying and configuring the kind of SchedulerClient that the
* factory builds. This client is either a TestAuthenticationClient or * factory builds.
* a WebAuthenticationClient, and the child element name is either * Currently only one kind of client, SchedulerDaemonXmlRpcClient is
* testAuthentication or webAuthentication, correspondingly. * supported by this factory.
* *
* An authenticationClientFactory configuration element may look like * An schedulerClientFactory configuration element may look like
* the following: * the following:
* *
* <pre><code> * <pre><code>
* &lt;authenticationClientFactory&gt; * &lt;schedulerClientFactory&gt;
* &lt;webAuthentication&gt; * &lt;schedulerDaemonXmlRpcClient&gt;
* ... * ...
* &lt;/webAuthentication&gt; * &lt;/schedulerDaemonXmlRpcClient&gt;
* &lt;/authenticationClientFactory&gt; * &lt;/schedulerClientFactory&gt;
* </code></pre> * </code></pre>
* *
* For detais of the testAuthentication and webAuthentication elements, see the * For detais of the schedulerDaemonXmlRpcClient element, see the
* documentation for the TestAuthenticationClient and WebAuthenticationClient * documentation for the SchedulerDaemonXmlRpcClient class.
* classes.
* *
* The DTD for the above element is: * The DTD for the above element is:
* *
* <pre><code> * <pre><code>
* &lt;!ELEMENT authenticationClientFactory (testAuthentication| * <!ELEMENT schedulerClientFactory (schedulerDaemonXmlRpcClient) >
* webAuthentication) &gt;
* </code></pre> * </code></pre>
* *
* @author $Author: maroy $ * @author $Author: maroy $
* @version $Revision: 1.1 $ * @version $Revision: 1.2 $
* @see TestAuthenticationClient * @see SchedulerDaemonXmlRpcClient
* @see WebAuthenticationClient
*/ */
class SchedulerClientFactory : virtual public Configurable class SchedulerClientFactory : virtual public Configurable
{ {