Merge branch 'security-CKM' into 'master'

[platform/upstream/iotivity.git] / resource / csdk / connectivity / inc / canetworkconfigurator.h

diff --git a/resource/csdk/connectivity/inc/canetworkconfigurator.h b/resource/csdk/connectivity/inc/canetworkconfigurator.h
index c74e099..775c516 100644 (file)
--- a/resource/csdk/connectivity/inc/canetworkconfigurator.h
+++ b/resource/csdk/connectivity/inc/canetworkconfigurator.h
@@ -1,4 +1,4 @@
-/******************************************************************
+/* ****************************************************************
  *
  * Copyright 2014 Samsung Electronics All Rights Reserved.
  *
@@ -17,13 +17,15 @@
  * limitations under the License.
  *
  ******************************************************************/
+
 /**
- * @file canetworkconfigurator.h
- * @brief This file contains  utility functions for network configurations.
+ * @file
+ *
+ * This file contains  utility function for network configurations.
  */
 
-#ifndef _NETWORK_CONFIGURATOR_H_
-#define _NETWORK_CONFIGURATOR_H_
+#ifndef NETWORK_CONFIGURATOR_H_
+#define NETWORK_CONFIGURATOR_H_
 
 #include "cacommon.h"
 #include "uarraylist.h"
@@ -34,36 +36,36 @@ extern "C"
 #endif
 
 /**
- * @brief   Add network type to the selected networks for network packets reception
- * @param   connectivityType       [IN]    connectivity type that needs to be added
- * @return  CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * Add network type to the selected networks for network packets reception.
+ * @param[in]   transportAdapter      Adapter that needs to be added.
+ * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
  */
-CAResult_t CAAddNetworkType(CAConnectivityType_t connectivityType);
+CAResult_t CAAddNetworkType(CATransportAdapter_t transportAdapter);
 
 /**
- * @brief   Remove network type from the selected configuration
- * @param   connectivityType       [IN]    connectivity type that needs to be removed
- * @return  CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * Remove network type from the selected configuration.
+ * @param[in]   transportAdapter       Adapter that needs to be removed.
+ * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
  */
-CAResult_t CARemoveNetworkType(CAConnectivityType_t connectivityType);
+CAResult_t CARemoveNetworkType(CATransportAdapter_t transportAdapter);
 
 /**
- * @brief   Get selected network information
- * @return array list having the connectivity types
+ * Get selected network information.
+ * @return array list having the connectivity types.
  */
 u_arraylist_t *CAGetSelectedNetworkList();
 
 /**
- * @brief  Getnetwork informations of the selected networks
- * @param   info    [OUT]   LocalConnectivity objects
- * @param   size    [OUT]   No Of Array objects
- * @return  CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * Get network informations of the selected networks.
+ * @param[out]   info       LocalConnectivity objects.
+ * @param[out]   size       No Of Array objects.
+ * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
  */
-CAResult_t CAGetNetworkInformationInternal(CALocalConnectivity_t **info, uint32_t *size);
+CAResult_t CAGetNetworkInformationInternal(CAEndpoint_t **info, uint32_t *size);
 
 /**
- * @brief   Terminate network type from selected configuration
- * @return  CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * Terminate network type from selected configuration.
+ * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
  */
 CAResult_t CATerminateNetworkType();
 
@@ -72,5 +74,5 @@ CAResult_t CATerminateNetworkType();
 } /* extern "C" */
 #endif
 
-#endif //#ifndef _NETWORK_CONFIGURATOR_H_
+#endif /* NETWORK_CONFIGURATOR_H_ */