[Syncml-ctoolkit-cvs] toolkit/src/sml/mgr/inc mgr.h,1.3,1.4 mgrutil.h,1.3,1.4

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/syncml-ctoolkit/toolkit/src/sml/mgr/inc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv10631/src/sml/mgr/inc

Modified Files:
	mgr.h mgrutil.h 
Log Message:
Modified comments to doxygen-readable
Removed duplicated comments

Index: mgrutil.h
===================================================================
RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/sml/mgr/inc/mgrutil.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** mgrutil.h	14 Nov 2003 09:43:26 -0000	1.3
--- mgrutil.h	24 May 2004 01:33:36 -0000	1.4
***************
*** 1,12 ****
! /*************************************************************************/
! /* module:          SyncML API for freeing SyncML C structures           */
! /*                                                                       */   
! /* file:            mgrutil.h                                            */
! /* target system:   all                                                  */
! /* target OS:       all                                                  */   
! /*                                                                       */   
! /* Description:                                                          */   
! /* Definitions for internal use within the SyncML implementation         */
! /*************************************************************************/

--- 1,10 ----
! /**
!  * @file 
!  * SyncML API for freeing SyncML C structures
!  *
!  * @target_system   all
!  * @target_os       all
!  * @description Definitions for internal use within the SyncML implementation
!  */

Index: mgr.h
===================================================================
RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/sml/mgr/inc/mgr.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** mgr.h	17 Apr 2004 09:30:41 -0000	1.3
--- mgr.h	24 May 2004 01:33:36 -0000	1.4
***************
*** 1,12 ****
! /*************************************************************************/
! /* module:          SyncML internal API of the MGR module                */
! /*                                                                       */   
! /* file:            mgr.h                                                */
! /* target system:   all                                                  */
! /* target OS:       all                                                  */   
! /*                                                                       */   
! /* Description:                                                          */   
! /* Definitions for internal use within the SyncML implementation         */
! /*************************************************************************/

--- 1,10 ----
! /**
!  * @file 
!  * SyncML internal API of the MGR module
!  *
!  * @target_system   all
!  * @target_os       all
!  * @description Definitions for internal use within the SyncML implementation
!  */

***************
*** 74,85 ****
  /**
   * Current instance status
!  **/
  typedef enum {
!   MGR_IDLE,                                   // instance is idle (available for usage by applications)
!   MGR_USED,                                   // instance is in use, but currently inactive
!   MGR_RECEIVE,                                // actively used for receiving (locked by application)
!   MGR_SEND,                                   // actively used for sending (locked by application)
!   MGR_ENCODING,                               // actively used for encoding (locked by SyncML)
!   MGR_DECODING                                // actively used for decoding (locked by SyncML)
  } InstanceStatus_t;

--- 72,83 ----
  /**
   * Current instance status
!  */
  typedef enum {
!   MGR_IDLE,     /**< instance is idle (available for usage by applications) */
!   MGR_USED,     /**< instance is in use, but currently inactive */
!   MGR_RECEIVE,  /**< actively used for receiving (locked by application) */
!   MGR_SEND,     /**< actively used for sending (locked by application) */
!   MGR_ENCODING, /**< actively used for encoding (locked by SyncML) */
!   MGR_DECODING  /**< actively used for decoding (locked by SyncML) */
  } InstanceStatus_t;

***************
*** 88,125 ****
  /** 
   * structure describing the current status of an instance,
!  **/
  typedef struct instance_info_s {
    #ifndef NOWSM
!   InstanceID_t             id;                // unique ID of the instance
!   MemPtr_t                 workspaceHandle;   // handle to the  first position of the assigned workspace memory
    #else
    // buffer pointers for NOWSM simplified case
!   MemPtr_t                 instanceBuffer;    // pointer to instance work buffer
!   MemSize_t                instanceBufSiz;    // size of currently allocated buffer
!   Byte_t                   readLocked;        // set when buffer is locked for read
!   Byte_t                   writeLocked;       // set when buffer is locked for read
!   MemPtr_t                 readPointer;       // read pointer
!   MemPtr_t                 writePointer;      // write pointer
!   MemPtr_t                 outgoingMsgStart;  // set whenever a smlStartMessage is issued, NULL when invalid
!   MemSize_t                maxOutgoingSize;   // if<>0, smlXXXCmd will not modify the buffer when there's not enough room
    #endif
!   InstanceStatus_t         status;            // current internal state of instance
!   SmlCallbacksPtr_t        callbacks;         // Defined callback refererences for this Instance
!   SmlInstanceOptionsPtr_t  instanceOptions;   // Defined options for this Instance (e.g. encoding type)
!   VoidPtr_t                userData;          // Pointer to a structure, which is passed to the invoked callback functions  
    #ifndef NOWSM
!   VoidPtr_t                workspaceState;	  // Pointer to a structure defining the current workspace status
    #endif
!   VoidPtr_t                encoderState;	    // Pointer to a structure defining the current encoder status
!   VoidPtr_t                decoderState;	    // Pointer to a structure defining the current decoder status
    #ifndef NOWSM
!   struct instance_info_s*  nextInfo;          // Pointer to next Instance Info in a list
    #else
!   smlPrintFunc  defaultPrintFunc;             // default application callback for displaying strings (is a global in original version)
    #endif
  } *InstanceInfoPtr_t, InstanceInfo_t;

! /* Pointers to store the global Tag tables */
  typedef struct tokeninfo_s {
      TagPtr_t  SyncML;
--- 86,123 ----
  /** 
   * structure describing the current status of an instance,
!  */
  typedef struct instance_info_s {
    #ifndef NOWSM
!   InstanceID_t             id;                /**< unique ID of the instance */
!   MemPtr_t                 workspaceHandle;   /**< handle to the  first position of the assigned workspace memory */
    #else
    // buffer pointers for NOWSM simplified case
!   MemPtr_t                 instanceBuffer;    /**< pointer to instance work buffer */
!   MemSize_t                instanceBufSiz;    /**< size of currently allocated buffer */
!   Byte_t                   readLocked;        /**< set when buffer is locked for read */
!   Byte_t                   writeLocked;       /**< set when buffer is locked for read */
!   MemPtr_t                 readPointer;       /**< read pointer */
!   MemPtr_t                 writePointer;      /**< write pointer */
!   MemPtr_t                 outgoingMsgStart;  /**< set whenever a smlStartMessage is issued, NULL when invalid */
!   MemSize_t                maxOutgoingSize;   /**< if<>0, smlXXXCmd will not modify the buffer when there's not enough room */
    #endif
!   InstanceStatus_t         status;            /**< current internal state of instance */
!   SmlCallbacksPtr_t        callbacks;         /**< Defined callback refererences for this Instance */
!   SmlInstanceOptionsPtr_t  instanceOptions;   /**< Defined options for this Instance (e.g. encoding type) */
!   VoidPtr_t                userData;          /**< Pointer to a structure, which is passed to the invoked callback functions   */
    #ifndef NOWSM
!   VoidPtr_t                workspaceState;	  /**< Pointer to a structure defining the current workspace status */
    #endif
!   VoidPtr_t                encoderState;	    /**< Pointer to a structure defining the current encoder status */
!   VoidPtr_t                decoderState;	    /**< Pointer to a structure defining the current decoder status */
    #ifndef NOWSM
!   struct instance_info_s*  nextInfo;          /**< Pointer to next Instance Info in a list */
    #else
!   smlPrintFunc  defaultPrintFunc;             /**< default application callback for displaying strings (is a global in original version) */
    #endif
  } *InstanceInfoPtr_t, InstanceInfo_t;

! /** Pointers to store the global Tag tables */
  typedef struct tokeninfo_s {
      TagPtr_t  SyncML;
***************
*** 134,142 ****
   * structure describing the current status of the global syncml module
   * (holds all global variables within SyncML)
!  **/
  typedef struct syncml_info_s {
!   InstanceInfoPtr_t        instanceListAnchor;// Anchor of the global list of known SyncML instances
!   SmlOptionsPtr_t          syncmlOptions;     // Options valid for this SyncML Process
!   WsmGlobalsPtr_t          wsmGlobals;        // Workspace global variables
    TokenInfoPtr_t           tokTbl;
  } *SyncMLInfoPtr_t, SyncMLInfo_t;
--- 132,140 ----
   * structure describing the current status of the global syncml module
   * (holds all global variables within SyncML)
!  */
  typedef struct syncml_info_s {
!   InstanceInfoPtr_t        instanceListAnchor;/**< Anchor of the global list of known SyncML instances */
!   SmlOptionsPtr_t          syncmlOptions;     /**< Options valid for this SyncML Process */
!   WsmGlobalsPtr_t          wsmGlobals;        /**< Workspace global variables */
    TokenInfoPtr_t           tokTbl;
  } *SyncMLInfoPtr_t, SyncMLInfo_t;
***************
*** 153,161 ****

  /**
-  * FUNCTION:  mgrGetSyncMLInfo
   * Retrieves a pointer to the structure holding all global informations within SyncML
   *
!  * RETURN:    SyncMLInfoPtr_t         
!  *            Pointer to the pGlobalAnchor
   */
  SyncMLInfoPtr_t mgrGetSyncMLAnchor(void);
--- 151,157 ----

  /**
   * Retrieves a pointer to the structure holding all global informations within SyncML
   *
!  * @return Pointer to the pGlobalAnchor
   */
  SyncMLInfoPtr_t mgrGetSyncMLAnchor(void);
***************
*** 163,171 ****

  /**
-  * FUNCTION:  mgrGetInstanceListAnchor
   * Retrieves a pointer to the list holding all instance informations
   *
!  * RETURN:    InstanceInfoPtr_t         
!  *            Pointer to the pInstanceListAnchor
   */
  InstanceInfoPtr_t mgrGetInstanceListAnchor(void);
--- 159,165 ----

  /**
   * Retrieves a pointer to the list holding all instance informations
   *
!  * @return Pointer to the pInstanceListAnchor
   */
  InstanceInfoPtr_t mgrGetInstanceListAnchor(void);
***************
*** 173,181 ****

  /**
-  * FUNCTION:  mgrSetInstanceListAnchor
   * Set the pointer to the list holding all instance informations
   *
!  * IN:        InstanceInfoPtr_t         
!  *            Pointer to the pInstanceListAnchor
   */
  void mgrSetInstanceListAnchor(InstanceInfoPtr_t newListAnchor);
--- 167,174 ----

  /**
   * Set the pointer to the list holding all instance informations
   *
!  * @param newListAnchor (IN)
!  *        pointer to the pInstanceListAnchor
   */
  void mgrSetInstanceListAnchor(InstanceInfoPtr_t newListAnchor);