Imported Upstream version 1.0.0

[platform/upstream/iotivity.git] / resource / csdk / connectivity / src / ip_adapter / arduino / caipadapterutils_eth.h

diff --git a/resource/csdk/connectivity/src/ip_adapter/arduino/caipadapterutils_eth.h b/resource/csdk/connectivity/src/ip_adapter/arduino/caipadapterutils_eth.h
index 668cfca..471193f 100644 (file)
--- a/resource/csdk/connectivity/src/ip_adapter/arduino/caipadapterutils_eth.h
+++ b/resource/csdk/connectivity/src/ip_adapter/arduino/caipadapterutils_eth.h
@@ -1,26 +1,26 @@
-/******************************************************************
-*
-* Copyright 2014 Samsung Electronics All Rights Reserved.
-*
-*
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*      http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-******************************************************************/
+/* ****************************************************************
+ *
+ * Copyright 2014 Samsung Electronics All Rights Reserved.
+ *
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ******************************************************************/
 
 /**
- * @file caethernetadapterutils.h
- * @brief This file provides APIs ethernet client/server/network monitor modules
+ * @file
+ * This file provides APIs ethernet client/server/network monitor modules.
  */
 
 #ifndef CA_ETHERNET_ADAPTER_UTILS_
@@ -45,27 +45,27 @@ extern "C"
 #endif
 
 /**
- * @brief Get available UDP socket
- * @param   sockID      [OUT]   Available UDP socket ID
- * @return  #CA_STATUS_OK or Appropriate error code
+ * Get available UDP socket.
+ * @param[out]   sockID         Available UDP socket ID.
+ * @return  ::CA_STATUS_OK or Appropriate error code.
  */
 CAResult_t CAArduinoGetAvailableSocket(int *sockID);
 
 /**
- * @brief Initialize Unicast UDP socket
- * @param   port        [INOUT] Port to start the unicast server
- * @param   socketID    [OUT    Unicast socket ID
- * @return  #CA_STATUS_OK or Appropriate error code
+ * Initialize Unicast UDP socket.
+ * @param[in/out]   port        Port to start the unicast server.
+ * @param[out]      socketID    Unicast socket ID.
+ * @return  ::CA_STATUS_OK or Appropriate error code.
  */
 CAResult_t CAArduinoInitUdpSocket(uint16_t *port, int *socketID);
 
 /**
- * @brief Initialize Multicast UDP socket
- * @param   mcastAddress    [IN]  Port to start the unicast server
- * @param   mport           [IN]  Multicast port
- * @param   lport           [IN]  Local port on which the server is started
- * @param   socketID        [OUT] Multicast socket ID
- * @return  #CA_STATUS_OK or Appropriate error code
+ * Initialize Multicast UDP socket.
+ * @param[in]   mcastAddress     Port to start the unicast server.
+ * @param[in]   mport            Multicast port.
+ * @param[in]   lport            Local port on which the server is started.
+ * @param[out]  socketID         Multicast socket ID.
+ * @return  ::CA_STATUS_OK or Appropriate error code.
  */
 CAResult_t CAArduinoInitMulticastUdpSocket(const char *mcastAddress,
                                            uint16_t mport, uint16_t lport,
@@ -76,5 +76,3 @@ CAResult_t CAArduinoInitMulticastUdpSocket(const char *mcastAddress,
 #endif
 
 #endif /* CA_ETHERNET_ADAPTER_UTILS_ */
-
-