[Syncml-ctoolkit-cvs] toolkit/src/sml/wsm/win wsm_sm.c,1.3,1.4

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

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

Modified Files:
	wsm_sm.c 
Log Message:
Modified comments to doxygen-readable
Removed duplicated comments


Index: wsm_sm.c
===================================================================
RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/sml/wsm/win/wsm_sm.c,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** wsm_sm.c	14 Nov 2003 09:52:08 -0000	1.3
--- wsm_sm.c	24 May 2004 01:33:38 -0000	1.4
***************
*** 1,8 ****
! /*************************************************************************/
! /* module:          SyncML WorkSpace Manager                             */
! /* file:            WSM_SM.c                                             */
! /* target system:   MS Windows                                           */
! /* target OS:       Windows 98 / NT                                      */
! /*************************************************************************/
  
  /*
--- 1,11 ----
! /**
!  * @file 
!  * SyncML WorkSpace Manager
!  *
!  * @target_system   MS Windows
!  * @target_os       Windows 98 / NT
!  * @description Storage Management for Workspace Manager API.
!  * MS Windows version.
!  */
  
  /*
***************
*** 43,53 ****
  
  
- /**
-  * Storage Management for Workspace Manager API. <BR>
-  * MS Windows version.
-  *
-  * @version  @label
-  *
-  */
  
  #ifndef NOWSM
--- 46,49 ----
***************
*** 130,134 ****
  /**
   * search for buffer with name eleName and return pointer to it in p.
!  * return == 0 if not found; 1 if found
   */
  // luz %%% NOTE: called only from routines which lock the toolkit already,
--- 126,133 ----
  /**
   * search for buffer with name eleName and return pointer to it in p.
!  *
!  * @return 
!  *         - 0 if not found;
!  *         - 1 if found
   */
  // luz %%% NOTE: called only from routines which lock the toolkit already,
***************
*** 147,151 ****
  /**
   * search for buffer with memHandle memH and return pointer to it in p.
!  * return == 0 if not found; 1 if found
   */
  // luz %%% NOTE: called only from routines which lock the toolkit already,
--- 146,153 ----
  /**
   * search for buffer with memHandle memH and return pointer to it in p.
!  *
!  * @return 
!  *         - 0 if not found;
!  *         - 1 if found
   */
  // luz %%% NOTE: called only from routines which lock the toolkit already,
***************
*** 194,220 ****
  
  /**
-  * FUNCTION: smCreate
-  *
   * Creates a new memory block with name memName and size memSize.
   *
!  * PRE-Condition:   OS does not know memName; memSize > 0
!  *
!  * POST-Condition:  memName exists with size memSize; 
!  *                  memH refers to new memory block.
!  *
!  * IN:      memName
!  *          Name of new memory block
!  * IN:      memSize
!  *          Size of new memory block
!  * 
!  * OUT:     memH
!  *          Handle to new memory block
!  *
!  * RETURN:  SML_ERR_OK, if O.K.
!  *          SML_ERR_WRONG_USAGE, if memName is already known to the OS
!  *          SML_ERR_INVALID_SIZE, if memSize <= 0
!  *          SML_ERR_NOT_ENOUGH_SPACE, if available memory < memSize
!  *
!  * @see  smDestroy
   */
  Ret_t smCreate (String_t memName, MemSize_t memSize, MemHandle_t *memH) {
--- 196,219 ----
  
  /**
   * Creates a new memory block with name memName and size memSize.
   *
!  * @pre 
!  *      - OS does not know memName
!  *      - memSize > 0
!  * @post
!  *       - memName exists with size memSize
!  *       - memH refers to new memory block.
!  * @param memName (IN)
!  *        Name of new memory block
!  * @param memSize (IN)
!  *        Size of new memory block
!  * @param memH (OUT)
!  *        Handle to new memory block
!  * @return 
!  *         - SML_ERR_OK, if O.K.
!  *         - SML_ERR_WRONG_USAGE, if memName is already known to the OS
!  *         - SML_ERR_INVALID_SIZE, if memSize <= 0
!  *         - SML_ERR_NOT_ENOUGH_SPACE, if available memory < memSize
!  * @see smDestroy
   */
  Ret_t smCreate (String_t memName, MemSize_t memSize, MemHandle_t *memH) {
***************
*** 251,273 ****
  
  /**
-  * FUNCTION: smOpen
-  *
   * Open connection to memory block with name memName.
   *
!  * PRE-Condition:   OS does know memName
!  *
!  * POST-Condition:  memH refers to memory block memName
!  *
!  * IN:      memName
!  *          Name of memory block to open<BR>
!  *          Windows version: Name is ignored
!  * 
!  * OUT:     memH
!  *          Handle to opened memory block
!  *
!  * RETURN:  SML_ERR_OK, if O.K.
!  *          SML_ERR_WRONG_PARAM, if memName is unknown
!  *
!  * @see  smClose
   */
  Ret_t smOpen (String_t memName, MemHandle_t *memH) {
--- 250,266 ----
  
  /**
   * Open connection to memory block with name memName.
   *
!  * @pre OS does know memName
!  * @post memH refers to memory block memName
!  * @param memName (IN)
!  *        Name of memory block to open\n
!  *        Windows version: Name is ignored
!  * @param memH (OUT)
!  *        Handle to opened memory block
!  * @return 
!  *         - SML_ERR_OK, if O.K.
!  *         - SML_ERR_WRONG_PARAM, if memName is unknown
!  * @see smClose
   */
  Ret_t smOpen (String_t memName, MemHandle_t *memH) {
***************
*** 284,303 ****
  
  /**
-  * FUNCTION: smClose
-  *
   * Close link to memory block.
   *
!  * PRE-Condition:   memH is a valid memory block handle; memH is unlocked;
!  *                  no pointers to records are in use
!  *
!  * POST-Condition:  memH is not valid anymore
!  *
!  * IN:      memH
!  *          Handle to close
!  *
!  * RETURN:  SML_ERR_OK, if O.K.
!  *          SML_ERR_WRONG_USAGE, if memH is locked or unknown
!  *
!  * @see  smOpen
   */
  Ret_t smClose (MemHandle_t memH) {
--- 277,293 ----
  
  /**
   * Close link to memory block.
   *
!  * @pre 
!  *      - memH is a valid memory block handle
!  *      - memH is unlocked
!  *      - no pointers to records are in use
!  * @post memH is not valid anymore
!  * @param memH (IN)
!  *        Handle to close
!  * @return 
!  *         - SML_ERR_OK, if O.K.
!  *         - SML_ERR_WRONG_USAGE, if memH is locked or unknown
!  * @see smOpen
   */
  Ret_t smClose (MemHandle_t memH) {
***************
*** 319,340 ****
  
  /**
-  * FUNCTION: smDestroy
-  *
   * Remove memory block memName within OS.
   *
!  * PRE-Condition:   memName is a valid memory block name; 
!  *                  memory block is not in use (i.e. no handles and 
!  *                  pointers to this memory block are in use)
!  *
!  * POST-Condition:  memName is not a valid memory block name anymore
!  *
!  * IN:      memName
!  *          Name of memory block to remove
!  *
!  * RETURN:  SML_ERR_OK, if O.K.
!  *          SML_ERR_WRONG_PARAM, if memName is unknown
!  *          SML_ERR_WRONG_USAGE, if memory block is still locked
!  *
!  * @see  smCreate
   */
  Ret_t smDestroy (String_t memName) {
--- 309,326 ----
  
  /**
   * Remove memory block memName within OS.
   *
!  * @pre 
!  *      - memName is a valid memory block name
!  *      - memory block is not in use (i.e. no handles and 
!  *        pointers to this memory block are in use)
!  * @post memName is not a valid memory block name anymore
!  * @param memName (IN)
!  *        Name of memory block to remove
!  * @return 
!  *         - SML_ERR_OK, if O.K.
!  *         - SML_ERR_WRONG_PARAM, if memName is unknown
!  *         - SML_ERR_WRONG_USAGE, if memory block is still locked
!  * @see smCreate
   */
  Ret_t smDestroy (String_t memName) {
***************
*** 356,380 ****
  
  /**
-  * FUNCTION: smLock
-  *
   * Map memory block memH to local address space.
   *
!  * PRE-Condition:   memH is a valid handle; memory block is not locked
!  *
!  * POST-Condition:  pMem points to memory block memH; 
!  *                  memory block is locked
!  *
!  * IN:      memH
!  *          Handle to memory block
!  * 
!  * OUT:     pMem
!  *          Pointer to memory block memH mapped in local address space
!  *
!  * RETURN:  SML_ERR_OK, if O.K.
!  *          SML_ERR_WRONG_PARAM, if memH is unknown
!  *          SML_ERR_WRONG_USAGE, if memH was already locked
!  *          SML_ERR_UNSPECIFIC, if lock failed
!  *
!  * @see  smUnlock
   */
  Ret_t smLock (MemHandle_t memH, MemPtr_t *pMem) {
--- 342,363 ----
  
  /**
   * Map memory block memH to local address space.
   *
!  * @pre 
!  *      - memH is a valid handle
!  *      - memory block is not locked
!  * @post 
!  *       - pMem points to memory block memH
!  *       - memory block is locked
!  * @param memH (IN)
!  *        Handle to memory block
!  * @param pMem (OUT)
!  *        Pointer to memory block memH mapped in local address space
!  * @return 
!  *         - SML_ERR_OK, if O.K.
!  *         - SML_ERR_WRONG_PARAM, if memH is unknown
!  *         - SML_ERR_WRONG_USAGE, if memH was already locked
!  *         - SML_ERR_UNSPECIFIC, if lock failed
!  * @see smUnlock
   */
  Ret_t smLock (MemHandle_t memH, MemPtr_t *pMem) {
***************
*** 396,416 ****
  
  /**
-  * FUNCTION: smUnlock
-  *
   * Free pointer mapped to memH memory block.
   *
!  * PRE-Condition:   memH is a valid handle; memory block is locked
!  *
!  * POST-Condition:  memory block is unlocked
!  *
!  * IN:      memH
!  *          Handle to memory block
!  *
!  * RETURN:  SML_ERR_OK, if O.K.
!  *          SML_ERR_WRONG_PARAM, if memH is unknown
!  *          SML_ERR_WRONG_USAGE, if memH was already unlocked
!  *          SML_ERR_UNSPECIFIC, if unlock failed
!  *
!  * @see  smLock
   */
  Ret_t smUnlock (MemHandle_t memH) {
--- 379,396 ----
  
  /**
   * Free pointer mapped to memH memory block.
   *
!  * @pre 
!  *      - memH is a valid handle
!  *      - memory block is locked
!  * @post memory block is unlocked
!  * @param memH (IN)
!  *        Handle to memory block
!  * @return 
!  *         - SML_ERR_OK, if O.K.
!  *         - SML_ERR_WRONG_PARAM, if memH is unknown
!  *         - SML_ERR_WRONG_USAGE, if memH was already unlocked
!  *         - SML_ERR_UNSPECIFIC, if unlock failed
!  * @see smLock
   */
  Ret_t smUnlock (MemHandle_t memH) {
***************
*** 431,455 ****
  
  /**
-  * FUNCTION: smSetSize
-  *
   * Set size of memory block memH to newSize.
   *
!  * PRE-Condition:   memH is a valid handle; newSize > 0; 
!  *                  memory block is unlocked
!  *
!  * POST-Condition:  memory block size = newSize
!  *
!  * IN:      memH
!  *          Handle to memory block
!  * IN:      newSize
!  *          New size of memory block
!  * 
!  * RETURN:  SML_ERR_OK, if O.K.
!  *          SML_ERR_WRONG_PARAM, if memH is unknown
!  *          SML_ERR_WRONG_USAGE, if memH is locked
!  *          SML_ERR_INVALID_SIZE, if newSize <= 0
!  *          SML_ERR_NOT_ENOUGH_SPACE, if available memory < newSize
!  *
!  * @see  smGetSize
   */
  Ret_t smSetSize (MemHandle_t memH, MemSize_t newSize) {
--- 411,432 ----
  
  /**
   * Set size of memory block memH to newSize.
   *
!  * @pre
!  *      - memH is a valid handle
!  *      - newSize > 0
!  *      - memory block is unlocked
!  * @post memory block size = newSize
!  * @param memH (IN)
!  *        Handle to memory block
!  * @param newSize (IN)
!  *        New size of memory block
!  * @return 
!  *         - SML_ERR_OK, if O.K.
!  *         - SML_ERR_WRONG_PARAM, if memH is unknown
!  *         - SML_ERR_WRONG_USAGE, if memH is locked
!  *         - SML_ERR_INVALID_SIZE, if newSize <= 0
!  *         - SML_ERR_NOT_ENOUGH_SPACE, if available memory < newSize
!  * @see smGetSize
   */
  Ret_t smSetSize (MemHandle_t memH, MemSize_t newSize) {
***************
*** 477,498 ****
  
  /**
-  * FUNCTION: smGetSize
-  *
   * Get size of memory block memH.
   *
!  * PRE-Condition:   memH is a valid handle
!  *
!  * POST-Condition:  actSize = memory block size
!  *
!  * IN:      memH
!  *          Handle to memory block
!  * 
!  * OUT:     actSize
!  *          Actual size of memory block
!  *
!  * RETURN:  SML_ERR_OK, if O.K.
!  *          SML_ERR_WRONG_PARAM, if memH is unknown
!  *
!  * @see  smSetSize
   */
  Ret_t smGetSize (MemHandle_t memH, MemSize_t *actSize) {
--- 454,469 ----
  
  /**
   * Get size of memory block memH.
   *
!  * @pre memH is a valid handle
!  * @post actSize = memory block size
!  * @param memH (IN)
!  *        Handle to memory block
!  * @param actSize (OUT)
!  *        Actual size of memory block
!  * @return 
!  *         - SML_ERR_OK, if O.K.
!  *         - SML_ERR_WRONG_PARAM, if memH is unknown
!  * @see smSetSize
   */
  Ret_t smGetSize (MemHandle_t memH, MemSize_t *actSize) {