syncml-ctoolkit-cvs

[Kidong L. <bri...@us...>]

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

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/palm/wsm_sm.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** wsm_sm.c	2 May 2003 22:05:08 -0000	1.2
--- wsm_sm.c	24 May 2004 01:33:38 -0000	1.3
***************
*** 1,13 ****
! /*************************************************************************/
! /* module:          SyncML WorkSpace Manager                             */
! /*                                                                       */
! /* file:            WSM_SM.c                                             */
! /* target system:   Palm                                                 */
! /* target OS:       PalmOS 3.5                                           */
! /*                                                                       */
! /* Description                                                           */
! /* Storage Management for Workspace Manager API. <BR>                    */
! /* Palm OS version.                                                      */
! /*************************************************************************/
  
  
--- 1,11 ----
! /**
!  * @file 
!  * SyncML WorkSpace Manager
!  *
!  * @target_system   Palm
!  * @target_os       PalmOS 3.5
!  * @description Storage Management for Workspace Manager API.
!  * Palm OS version.
!  */
  
  
***************
*** 50,59 ****
  
  
- /**
-  * @version  @label
-  */
- 
- 
- 
  /*************************************************************************
   *  Definitions                                                          *
--- 48,51 ----
***************
*** 90,119 ****
  
  
- /**
-  * 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<BR>
-  *          Palm version: Name is ignored
-  * 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) {
  
--- 82,85 ----
***************
*** 141,167 ****
  
  
- /**
-  * FUNCTION: smOpen
-  *
-  * Open connection to memory block with name memName.<BR>
-  * Palm version: As this version is based on non-persitent memory, it
-  * returns SML_ERR_WRONG_PARAM, if create was not called before.
-  *
-  * PRE-Condition:   OS does know memName
-  *
-  * POST-Condition:  memH refers to memory block memName
-  *
-  * IN:      memName
-  *          Name of memory block to open<BR>
-  *          Palm 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) {
  
--- 107,110 ----
***************
*** 175,196 ****
  
  
- /**
-  * 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
-  *
-  * @see  smOpen
-  */
  Ret_t smClose (MemHandle_t memH) {
    Err ret;
--- 118,121 ----
***************
*** 207,233 ****
  
  
- /**
-  * FUNCTION: smDestroy
-  *
-  * Remove memory block memName within OS.<BR>
-  * Palm version: As this version is based on non-persitent memory, no 
-  * action is performed and it alway returns SML_ERR_OK.
-  *
-  * 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<BR>
-  *          Palm version: Name is ignored
-  *
-  * 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) {
  
--- 132,135 ----
***************
*** 236,262 ****
  
  
- /**
-  * 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) {
  
--- 138,141 ----
***************
*** 277,299 ****
  
  
- /**
-  * 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) {
  
--- 156,159 ----
***************
*** 314,340 ****
  
  
- /**
-  * 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) {
    Err ret;
--- 174,177 ----
***************
*** 358,381 ****
  
  
- /**
-  * 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) {
  
--- 195,198 ----
***************
*** 388,393 ****
  }
  
- 
- 
- 
- 
--- 205,206 ----