Diff: Spwf_API/utils/ItfTranslator.cpp

Revision:

12:3799f8475c8a

Parent:

8:0f302a13e21b

--- a/Spwf_API/utils/ItfTranslator.cpp	Sat May 14 07:28:29 2016 +0000
+++ b/Spwf_API/utils/ItfTranslator.cpp	Sat May 14 08:31:39 2016 +0000
@@ -49,6 +49,12 @@
 extern "C" {
 #endif
 
+/**
+* @brief  Wrapper function to CPP
+*         Calls SpwfSADevice init
+* @param  void* not used
+* @retval None
+*/
 void callSpwfSADevice_init(void* object)
  {
     //static_cast<SpwfSADevice*>(object)->init();
@@ -56,46 +62,106 @@
     return;
  }
 
+/**
+* @brief  Wrapper function to CPP
+*         Calls SpwfSADevice getChar
+* @param  void* not used
+* @retval None
+*/
 char callSpwfSADevice_getChar(void* object)
  {
     return(device->spwf_get());
  }
 
+/**
+* @brief  Wrapper function to CPP
+*         Calls SpwfSADevice write
+* @param  void* not used
+*         cmd: data to write
+*         size: size of data
+* @retval None
+*/
 int callSpwfSADevice_write(void* object, const char * cmd, uint16_t size)
  {
    return (device->spwf_send(cmd, size));
  }
- 
+
+/**
+* @brief  Wrapper function to CPP
+*         Calls SpwfSADevice wakeup
+* @param  void* not used
+*         wake: (re)set wakeup pin value
+* @retval None
+*/
 void callSpwfSADevice_wakeup(void* object, int wake)
 {
   device->spwf_wakeup(wake);
 }
 
+/**
+* @brief  Wrapper function to CPP
+*         Calls SpwfSADevice reset
+* @param  void* not used
+*         reset: (re)set reset pin value
+* @retval None
+*/
 void callSpwfSADevice_reset(void* object, int reset)
 {
   device->spwf_reset(reset);
 }
-   
+
+/**
+* @brief  Wrapper function to CPP
+*         Calls SpwfSADevice read_rts
+* @param  void* not used
+*         rts: (re)set RTS pin value
+* @retval None
+*/
 void callSpwfSADevice_rts(void* object, int rts)
 {
   device->spwf_rts(rts);
 }
 
+/**
+* @brief  Wrapper function to CPP
+*         Calls SpwfSADevice read_rts
+* @param  void* not used
+* @retval RTS value
+*/
 int callSpwfSADevice_read_rts(void* object)
 {
   return(device->spwf_read_rts());
 }
 
+/**
+* @brief  Wrapper function to CPP
+*         Calls SpwfSADevice attach
+* @param  attach boolean
+* @retval None
+*/
 void callSpwfSADevice_attach(wifi_bool attach)
 {
   device->spwf_attach_irq(attach);
 }
 
+/**
+* @brief  Wrapper function to CPP
+*         Calls SpwfSADevice debug
+* @param  void* not used
+*         string: data string to debug print
+* @retval None
+*/
 void callSpwfSADevice_debug(void* object, const char * string)
 {
   device->debug_print(string);
 }
 
+/**
+* @brief  Wrapper function to CPP
+*         not used
+* @param  void* not used
+* @retval None
+*/
 void destroySpwfSADevice()
  {