cvs commit: ws-axis/c/include/axis Axis.hpp

[wh...@apache.org]

whitlock    2005/03/11 06:44:35

  Modified:    c/include/axis Axis.hpp
  Log:
  Better API documentation for the Axis class
  
  Revision  Changes    Path
  1.4       +19 -0     ws-axis/c/include/axis/Axis.hpp
  
  Index: Axis.hpp
  ===================================================================
  RCS file: /home/cvs/ws-axis/c/include/axis/Axis.hpp,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- Axis.hpp	23 Nov 2004 15:48:56 -0000	1.3
  +++ Axis.hpp	11 Mar 2005 14:44:35 -0000	1.4
  @@ -28,10 +28,29 @@
   
   AXIS_CPP_NAMESPACE_START
   
  +/**
  + * @class Axis
  + *
  + * Contains methods to initialize and terminate the Axis runtime. Creating a stub also initializes
  + * the Axis runtime and deleting the stub terminates it. So simple applications that only ever
  + * use one stub at a time do not need to call these methods. More complicated applications that 
  + * initialize multiple stubs, use them and delete them later, should initialize Axis at the start
  + * of their application using Axis::initialize and terminate Axis at the very end of their 
  + * application with Axis::terminate. Applications that use Axis in multiple threads should also 
  + * call Axis:: initialize and terminate.
  + */
   class STORAGE_CLASS_INFO Axis
   {
     public:
  +	/**
  +	 * Initializes the Axis runtime.
  +	 * @param bIsServer should be set to false for client applications.
  +	 */
       static void initialize(bool bIsServer);
  +
  +	/**
  +	 * Terminates the Axis runtime.
  +	 */
       static void terminate();
   };