Diff: mbedOSC.h

Revision:

4:f365c577b3c6

Parent:

3:2b56849146d8

Child:

5:247b80b139d3

--- a/mbedOSC.h	Sun Apr 15 12:52:48 2012 +0000
+++ b/mbedOSC.h	Sun Apr 15 12:55:04 2012 +0000
@@ -208,7 +208,7 @@
  */    
         void setIp( uint8_t *_ip );    //set ip
 
-/*!
+/**
  Set IP Address to the OSC Message container (not through pointer)
  Example: IP=192.168.0.99 => setIp(192,168,0,99)
  */    
@@ -224,7 +224,7 @@
          */
         void setPort( uint16_t _port );
     
-/*
+/**
  Set TypeTag and args to the OSC Message container
  @param[in] types TypeTag string "i"(integer) or"f"(float) (char *)
  @param[in] ... Pointer of the Args(variable argument) ..
@@ -271,32 +271,32 @@
     /** Create an object to send and receive OSC messages */
     OSCClass();
     
-/*
+/**
  This sets "binds" the received message to the receiver container of the communication object
  @param[in]<--_mes is a pointer to the "receiveing" OSC message (OSCMessage *)
  */
     OSCClass(OSCMessage *_mes); // set the receiver message container
 
-/*
+/**
  Ignore: See messageReceivedCallback instead. This is called by the UDPSocket... and should be a protected function and we friend UDPSocket?
  */
     void onUDPSocketEvent(UDPSocketEvent e);
         
-/*
+/**
  This initializes the OSC communication object with default receiving port (DEFAULT_REC_PORT)
  param[in]: None
  return: None
  */
     void begin();
 
-/*
+/**
  Initialize an OSC object with arbitrary listening port
  param[in] <-- _recievePort, is the listening ("receiving") Port No (unsigned int)
  return: None
  */
     void begin(uint16_t _recievePort);
 
-/*
+/**
  Stop OSC communication (in fact, only the receiver - the server side)
  */
     void stop();
@@ -304,14 +304,14 @@
     //new OSC data in the receiver message container: 
     bool newMessage;
 
-/*
+/**
  Set a OSC receive message container
  param[in] _mes Pointer to the OSC receive message container (OSCMessage *)
  return None
  */
     void setReceiveMessage( OSCMessage *_mes ); //set receive OSCmessage container (note: the message has a "host" object from which we get the upd packets)
 
-/*
+/**
  Get the received OSC message (note: this is another way to access the message directly from the OSCClass object).
  The advantage is that we will signal that we read the message, and will be able to query if a NEW message arrived
  (Alternatively, one could have a function pointer to pass to the OSC object, that will be called each time a new packet is received: TO DO) 
@@ -321,7 +321,7 @@
     //buffer clear
     //void flush();    
     
-/*
+/**
  Send an OSC Message (message contain the host ip and port where the message data has to be sent)
  param[in] _mes Pointer to the OSC message container (OSCMessage *)
  return None