syncml-ctoolkit-cvs

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

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

Modified Files:
	builder_wrapper.c builder_wrapper.h callback_handler.c 
	callback_handler.h receiver.c sender.c 
Log Message:
Modified comments to doxygen-readable
Removed duplicated comments



Index: receiver.c
===================================================================
RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/examples/receiver.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** receiver.c	14 Apr 2004 18:11:27 -0000	1.2
--- receiver.c	24 May 2004 01:33:33 -0000	1.3
***************
*** 1,4 ****
  /**
!  * @file Receiver exmple
   */
  #include <stdio.h>
--- 1,5 ----
  /**
!  * @file
!  * SyncML API example - Receiver
   */
  #include <stdio.h>

Index: callback_handler.h
===================================================================
RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/examples/callback_handler.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** callback_handler.h	11 Apr 2004 15:17:21 -0000	1.1
--- callback_handler.h	24 May 2004 01:33:33 -0000	1.2
***************
*** 1,2 ****
--- 1,6 ----
+ /**
+  * @file
+  * Sync Command Calling Callback Implementations - Header
+  */
  #ifndef _CALLBACK_HANDLER_H
  #define _CALLBACK_HANDLER_H

Index: sender.c
===================================================================
RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/examples/sender.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** sender.c	14 Apr 2004 18:11:27 -0000	1.2
--- sender.c	24 May 2004 01:33:33 -0000	1.3
***************
*** 1,4 ****
  /**
!  * @file Sender exmple
   */
  #include <stdio.h>
--- 1,5 ----
  /**
!  * @file
!  * SyncML API example - Sender
   */
  #include <stdio.h>
***************
*** 17,20 ****
--- 18,22 ----
   *
   * @param id instance ID
+  * @param serviceID transport service ID
   * @return return value of xptSendData
   * @see xptSendData
***************
*** 60,64 ****
          char receiveBuf[10000 + 1] = "";
  
!         /* NOTE: Should receive at least more than one data */
          C(xptReceiveData(conn, receiveBuf, 1, &bytesReceived));
      }
--- 62,66 ----
          char receiveBuf[10000 + 1] = "";
  
!         /* Should receive at least more than one byte */
          C(xptReceiveData(conn, receiveBuf, 1, &bytesReceived));
      }

Index: callback_handler.c
===================================================================
RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/examples/callback_handler.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** callback_handler.c	17 Apr 2004 12:05:00 -0000	1.2
--- callback_handler.c	24 May 2004 01:33:33 -0000	1.3
***************
*** 1,4 ****
  /**
!  * @file Callback implementations
   */
  #include "callback_handler.h"
--- 1,5 ----
  /**
!  * @file
!  * Sync Command Calling Callback Implementations
   */
  #include "callback_handler.h"
***************
*** 11,20 ****
  
  /**
!  * Callback handling <SyncHdr> tag
   *
   * @param id instance ID
!  * @param pSync pointer containing infomation about <SyncHdr> block
!  * @return SML_ERR_OK(=0)
!  * @see smlInitInstance
   */
  Ret_t myHandleStartMessage(InstanceID_t id, VoidPtr_t userData,
--- 12,22 ----
  
  /**
!  * Callback handling \<SyncHdr\> tag
   *
   * @param id instance ID
!  * @param userData user defined data, not used here
!  * @param pSyncHdr pointer containing infomation about \<SyncHdr\> block
!  * @return SML_ERR_OK
!  * @see smlStartMessageFunc
   */
  Ret_t myHandleStartMessage(InstanceID_t id, VoidPtr_t userData,
***************
*** 42,51 ****
  
  /**
!  * Callback handling <Sync> command
   *
   * @param id instance ID
!  * @param pSync pointer containing infomation about <Sync> block
!  * @return SML_ERR_OK(=0)
!  * @see smlInitInstance
   */
  Ret_t myHandleStartSync(InstanceID_t id, VoidPtr_t userData,
--- 44,54 ----
  
  /**
!  * Callback handling \<Sync\> tag
   *
   * @param id instance ID
!  * @param userData user defined data, not used here
!  * @param pSync pointer containing infomation about \<Sync\> block
!  * @return SML_ERR_OK
!  * @see smlStartSyncFunc
   */
  Ret_t myHandleStartSync(InstanceID_t id, VoidPtr_t userData,
***************
*** 64,73 ****
  
  /**
!  * Callback handling <Add> command
   *
   * @param id instance ID
!  * @param pSync pointer containing infomation about <Add> command
!  * @return SML_ERR_OK(=0)
!  * @see smlInitInstance
   */
  Ret_t myHandleAdd(InstanceID_t id, VoidPtr_t userData, SmlAddPtr_t pAdd)
--- 67,77 ----
  
  /**
!  * Callback handling \<Add\> command
   *
   * @param id instance ID
!  * @param userData user defined data, not used here
!  * @param pAdd pointer containing infomation about \<Add\> command
!  * @return SML_ERR_OK
!  * @see smlAddCmdFunc
   */
  Ret_t myHandleAdd(InstanceID_t id, VoidPtr_t userData, SmlAddPtr_t pAdd)
***************
*** 93,96 ****
--- 97,108 ----
  }
  
+ /**
+  * Callback handling \</Sync\> tag
+  *
+  * @param id instance ID
+  * @param userData user defined data, not used here
+  * @return SML_ERR_OK
+  * @see smlEndSyncFunc
+  */
  Ret_t myHandleEndSync(InstanceID_t id, VoidPtr_t userData)
  {
***************
*** 99,102 ****
--- 111,123 ----
  }
  
+ /**
+  * Callback handling \</SyncHdr\> tag
+  *
+  * @param id instance ID
+  * @param userData user defined data, not used here
+  * @param final Final Flag indicates last message within a package
+  * @return SML_ERR_OK
+  * @see smlEndMessageFunc
+  */
  Ret_t myHandleEndMessage(InstanceID_t id, VoidPtr_t userData, Boolean_t final)
  {

Index: builder_wrapper.h
===================================================================
RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/examples/builder_wrapper.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** builder_wrapper.h	11 Apr 2004 15:17:21 -0000	1.1
--- builder_wrapper.h	24 May 2004 01:33:33 -0000	1.2
***************
*** 1,2 ****
--- 1,6 ----
+ /**
+  * @file
+  * Sync Command Builder Wrapper - Header
+  */
  #ifndef _BUILDER_WRAPPER_H
  #define _BUILDER_WRAPPER_H
***************
*** 16,20 ****
  Ret_t myInitInstance(InstanceID_t * pID);
  Ret_t myStartMessage(InstanceID_t id);
- Ret_t myAlertCmd(InstanceID_t id);
  Ret_t myStartSync(InstanceID_t id);
  Ret_t myAddCmd(InstanceID_t id);
--- 20,23 ----

Index: builder_wrapper.c
===================================================================
RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/examples/builder_wrapper.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** builder_wrapper.c	17 Apr 2004 12:05:00 -0000	1.2
--- builder_wrapper.c	24 May 2004 01:33:33 -0000	1.3
***************
*** 1,4 ****
  /**
!  * @file Command builder wrapper
   */
  #include "builder_wrapper.h"
--- 1,5 ----
  /**
!  * @file
!  * Sync Command Builder Wrapper
   */
  #include "builder_wrapper.h"