From: Jon A. Cruz Date: Fri, 6 Mar 2015 00:44:03 +0000 (-0800) Subject: Corrected @file tags and restored 'Files' section. X-Git-Tag: 1.2.0+RC1~1905 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=c8a6d2bf0605f0616c8e7fa5c389a1dbb8918071;p=platform%2Fupstream%2Fiotivity.git Corrected @file tags and restored 'Files' section. * Corrected @file tags that were inadvertently broken which left their comments falling to the next item to be documented. * Removed unnecessary '@brief' tags and explicit filenames. The latter are only required when the @file is targeting a source other than the one it is present in. * Unified formatting of @file doc comment blocks. * Added 'Files' section back to generated docs. Change-Id: I7f3fbc3cecf5a922c9f8a98d673bc91a18be8847 Signed-off-by: Jon A. Cruz Reviewed-on: https://gerrit.iotivity.org/gerrit/449 Tested-by: jenkins-iotivity Reviewed-by: Erich Keane Reviewed-by: William Dieter Reviewed-by: Patrick Lankswert --- diff --git a/resource/csdk/connectivity/api/cacommon.h b/resource/csdk/connectivity/api/cacommon.h index 7e4cda1..7550fab 100644 --- a/resource/csdk/connectivity/api/cacommon.h +++ b/resource/csdk/connectivity/api/cacommon.h @@ -1,4 +1,4 @@ -/****************************************************************** +/* **************************************************************** * * Copyright 2014 Samsung Electronics All Rights Reserved. * @@ -19,9 +19,12 @@ ******************************************************************/ /** - * @file cacommon.h - * @brief This file contains the common data structures between Resource , CA and adapters + * @file + * + * This file contains the common data structures between Resource, CA and + * adapters. */ + #ifndef __CA_COMMON_H_ #define __CA_COMMON_H_ diff --git a/resource/csdk/connectivity/api/cainterface.h b/resource/csdk/connectivity/api/cainterface.h index 8619f92..ec6916e 100644 --- a/resource/csdk/connectivity/api/cainterface.h +++ b/resource/csdk/connectivity/api/cainterface.h @@ -1,4 +1,4 @@ -/****************************************************************** +/* **************************************************************** * * Copyright 2014 Samsung Electronics All Rights Reserved. * @@ -19,8 +19,9 @@ ******************************************************************/ /** - * @file cainterface.h - * @brief This file contains the APIs for Resource Model to use + * @file + * + * This file contains the APIs for Resource Model to use. */ #ifndef __CA_INTERFACE_H_ diff --git a/resource/csdk/connectivity/common/inc/umutex.h b/resource/csdk/connectivity/common/inc/umutex.h index 30f8336..82f6357 100644 --- a/resource/csdk/connectivity/common/inc/umutex.h +++ b/resource/csdk/connectivity/common/inc/umutex.h @@ -1,8 +1,9 @@ -/****************************************************************** +/* **************************************************************** * * 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 @@ -16,9 +17,11 @@ * limitations under the License. * ******************************************************************/ + /** - * @file umutex.h - * @brief This file provides APIs related to mutex and semaphores + * @file + * + * This file provides APIs related to mutex and semaphores. */ #ifndef __UMUTEX_H_ diff --git a/resource/csdk/connectivity/common/inc/uqueue.h b/resource/csdk/connectivity/common/inc/uqueue.h index b40be81..079ac87 100644 --- a/resource/csdk/connectivity/common/inc/uqueue.h +++ b/resource/csdk/connectivity/common/inc/uqueue.h @@ -1,4 +1,4 @@ -/****************************************************************** +/* **************************************************************** * * Copyright 2014 Samsung Electronics All Rights Reserved. * @@ -19,9 +19,11 @@ ******************************************************************/ /** - * @file uqueue.h - * @brief This file contains the APIs for queue to be implemented + * @file + * + * This file contains the APIs for queue to be implemented. */ + #ifndef __U_QUEUE_H_ #define __U_QUEUE_H_ diff --git a/resource/csdk/connectivity/common/inc/uthreadpool.h b/resource/csdk/connectivity/common/inc/uthreadpool.h index fefb852..bffe255 100644 --- a/resource/csdk/connectivity/common/inc/uthreadpool.h +++ b/resource/csdk/connectivity/common/inc/uthreadpool.h @@ -1,8 +1,9 @@ -/****************************************************************** +/* **************************************************************** * * 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 @@ -16,9 +17,11 @@ * limitations under the License. * ******************************************************************/ + /** - * @file uthreadpool.h - * @brief This file provides APIs related to thread pool + * @file + * + * This file provides APIs related to thread pool. */ #ifndef __UTHREAD_POOL_H_ diff --git a/resource/csdk/connectivity/common/src/umutex.c b/resource/csdk/connectivity/common/src/umutex.c index 6575453..8b06d3a 100644 --- a/resource/csdk/connectivity/common/src/umutex.c +++ b/resource/csdk/connectivity/common/src/umutex.c @@ -1,8 +1,9 @@ -/****************************************************************** +/* **************************************************************** * * 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 @@ -16,9 +17,10 @@ * limitations under the License. * ******************************************************************/ + /** - * @file umutex.c - * @brief This file provides APIs related to mutex and semaphores + * @file + * This file provides APIs related to mutex and semaphores. */ #include "umutex.h" diff --git a/resource/csdk/connectivity/inc/caadapterinterface.h b/resource/csdk/connectivity/inc/caadapterinterface.h index 67a44cb..c0b9fff 100644 --- a/resource/csdk/connectivity/inc/caadapterinterface.h +++ b/resource/csdk/connectivity/inc/caadapterinterface.h @@ -1,4 +1,4 @@ -/****************************************************************** +/* **************************************************************** * * Copyright 2014 Samsung Electronics All Rights Reserved. * @@ -19,9 +19,11 @@ ******************************************************************/ /** - * @file caadapterinterface.h - * @brief This file contains the APIs for adapters to be implemented + * @file + * + * This file contains the APIs for adapters to be implemented. */ + #ifndef __CA_ADAPTER_INTERFACE_H_ #define __CA_ADAPTER_INTERFACE_H_ diff --git a/resource/csdk/connectivity/inc/caedradapter.h b/resource/csdk/connectivity/inc/caedradapter.h index 2b68a07..d4baec0 100644 --- a/resource/csdk/connectivity/inc/caedradapter.h +++ b/resource/csdk/connectivity/inc/caedradapter.h @@ -1,4 +1,4 @@ -/****************************************************************** +/* **************************************************************** * * Copyright 2014 Samsung Electronics All Rights Reserved. * @@ -17,10 +17,13 @@ * limitations under the License. * ******************************************************************/ + /** - * @file caedradapter.h - * @brief This file contains the APIs for EDR adapters to be implemented + * @file + * + * This file contains the APIs for EDR adapters to be implemented. */ + #ifndef __CA_EDRADAPTER_H_ #define __CA_EDRADAPTER_H_ diff --git a/resource/csdk/connectivity/inc/caethernetadapter.h b/resource/csdk/connectivity/inc/caethernetadapter.h index 61e8a4d..1afb256 100644 --- a/resource/csdk/connectivity/inc/caethernetadapter.h +++ b/resource/csdk/connectivity/inc/caethernetadapter.h @@ -1,4 +1,4 @@ -/****************************************************************** +/* **************************************************************** * * Copyright 2014 Samsung Electronics All Rights Reserved. * @@ -19,9 +19,11 @@ ******************************************************************/ /** - * @file caethernetadapter.h - * @brief This file contains the APIs for Ethernet Adapter. + * @file + * + * This file contains the APIs for Ethernet Adapter. */ + #ifndef __CA_ETHERNET_ADAPTER_H__ #define __CA_ETHERNET_ADAPTER_H__ diff --git a/resource/csdk/connectivity/inc/caleadapter.h b/resource/csdk/connectivity/inc/caleadapter.h index a99d161..d160e7c 100644 --- a/resource/csdk/connectivity/inc/caleadapter.h +++ b/resource/csdk/connectivity/inc/caleadapter.h @@ -1,4 +1,4 @@ -/****************************************************************** +/* **************************************************************** * * Copyright 2014 Samsung Electronics All Rights Reserved. * @@ -19,9 +19,11 @@ ******************************************************************/ /** - * @file caleadapter.h - * @brief This file contains the APIs for LE adapters to be implemented + * @file + * + * This file contains the APIs for LE adapters to be implemented. */ + #ifndef _CA_LEADAPTER_H_ #define _CA_LEADAPTER_H_ diff --git a/resource/csdk/connectivity/inc/cawifiadapter.h b/resource/csdk/connectivity/inc/cawifiadapter.h index 07ad36a..12ff114 100644 --- a/resource/csdk/connectivity/inc/cawifiadapter.h +++ b/resource/csdk/connectivity/inc/cawifiadapter.h @@ -1,4 +1,4 @@ -/****************************************************************** +/* **************************************************************** * * Copyright 2014 Samsung Electronics All Rights Reserved. * @@ -19,9 +19,11 @@ ******************************************************************/ /** - * @file cawifiadapter.h - * @brief This file contains the APIs for WiFi Adapter. + * @file + * + * This file contains the APIs for WiFi Adapter. */ + #ifndef __CA_WIFI_ADAPTER_H__ #define __CA_WIFI_ADAPTER_H__ diff --git a/resource/csdk/connectivity/inc/cawificore.h b/resource/csdk/connectivity/inc/cawificore.h index 64e7a20..60cde15 100644 --- a/resource/csdk/connectivity/inc/cawificore.h +++ b/resource/csdk/connectivity/inc/cawificore.h @@ -1,4 +1,4 @@ -/****************************************************************** +/* **************************************************************** * * Copyright 2014 Samsung Electronics All Rights Reserved. * @@ -19,9 +19,11 @@ ******************************************************************/ /** - * @file cawificore.h - * @brief This file contains the APIs for Wi-Fi communications. + * @file + * + * This file contains the APIs for Wi-Fi communications. */ + #ifndef __CA_WIFICORE_H_ #define __CA_WIFICORE_H_ diff --git a/resource/csdk/connectivity/inc/cawifiethernetadapter.h b/resource/csdk/connectivity/inc/cawifiethernetadapter.h index 45dcab8..930526d 100644 --- a/resource/csdk/connectivity/inc/cawifiethernetadapter.h +++ b/resource/csdk/connectivity/inc/cawifiethernetadapter.h @@ -1,4 +1,4 @@ -/****************************************************************** +/* **************************************************************** * * Copyright 2014 Samsung Electronics All Rights Reserved. * @@ -19,9 +19,11 @@ ******************************************************************/ /** - * @file cawifiethernetadapter.h - * @brief This file contains the APIs for WiFi/Ethernet Adapter. + * @file + * + * This file contains the APIs for WiFi/Ethernet Adapter. */ + #ifndef __CA_WIFI_ETHERNET_ADAPTER_H__ #define __CA_WIFI_ETHERNET_ADAPTER_H__ diff --git a/resource/docs/doxygenLayout.xml b/resource/docs/doxygenLayout.xml index cb1f63a..330cb9a 100644 --- a/resource/docs/doxygenLayout.xml +++ b/resource/docs/doxygenLayout.xml @@ -6,5 +6,9 @@ + + + + diff --git a/resource/include/AttributeValue.h b/resource/include/AttributeValue.h index be07173..327bf13 100644 --- a/resource/include/AttributeValue.h +++ b/resource/include/AttributeValue.h @@ -1,4 +1,3 @@ - //****************************************************************** // // Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved. @@ -19,10 +18,12 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file AttributeValue.h - -/// @brief This file contains the definition of the internally used -// type AttributeValue +/** + * @file + * + * This file contains the definition of the internally used type + * AttributeValue. + */ #ifndef __ATTRIBUTEVALUE_H #define __ATTRIBUTEVALUE_H diff --git a/resource/include/OCHeaderOption.h b/resource/include/OCHeaderOption.h index 2e2becf..c70ecc0 100644 --- a/resource/include/OCHeaderOption.h +++ b/resource/include/OCHeaderOption.h @@ -18,10 +18,12 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file OCHeaderOption.h - -/// @brief This file contains the declaration of classes and its members related to -/// OCHeaderOption. +/** + * @file + * + * This file contains the declaration of classes and its members related to + * OCHeaderOption. + */ #ifndef __OCHEADEROPTION_H #define __OCHEADEROPTION_H diff --git a/resource/include/OCPlatform.h b/resource/include/OCPlatform.h index c2a2eae..193462f 100644 --- a/resource/include/OCPlatform.h +++ b/resource/include/OCPlatform.h @@ -18,10 +18,12 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file OCPlatform.h - -/// @brief This file contains the declaration of classes and its members related to -/// OCPlatform. +/** + * @file + * + * This file contains the declaration of classes and its members related to + * OCPlatform. + */ #ifndef __OCPLATFORM_H #define __OCPLATFORM_H diff --git a/resource/include/OCPlatform_impl.h b/resource/include/OCPlatform_impl.h index f25ce2e..8adcc29 100644 --- a/resource/include/OCPlatform_impl.h +++ b/resource/include/OCPlatform_impl.h @@ -18,11 +18,13 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file OCPlatform_impl.h - -/// @brief Implementation of the OCPlatform functionality. It contains -/// a singleton interface that is used only by the OCPlatform namespace and is the -/// central entrance to the stack. +/** + * @file + * + * Implementation of the OCPlatform functionality. It contains a singleton + * interface that is used only by the OCPlatform namespace and is the + * central entrance to the stack. + */ #ifndef __OCPLATFORM_IMPL_H #define __OCPLATFORM_IMPL_H diff --git a/resource/include/OCRepresentation.h b/resource/include/OCRepresentation.h index 47c9c47..ef9d1a9 100644 --- a/resource/include/OCRepresentation.h +++ b/resource/include/OCRepresentation.h @@ -18,10 +18,12 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file OCRepresentation.h - -/// @brief This file contains the declaration of classes and its members -/// related to OCRepresentation +/** + * @file + * + * This file contains the declaration of classes and its members related + * to OCRepresentation. + */ #ifndef __OCREPRESENTATION_H #define __OCREPRESENTATION_H diff --git a/resource/include/OCResource.h b/resource/include/OCResource.h index b6e9f3d..98ed87a 100644 --- a/resource/include/OCResource.h +++ b/resource/include/OCResource.h @@ -18,10 +18,12 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file OCResource.h - -/// @brief This file contains the declaration of classes and its members related to -/// Resource. +/** + * @file + * + * This file contains the declaration of classes and its members related to + * Resource. + */ #ifndef __OCRESOURCE_H #define __OCRESOURCE_H diff --git a/resource/include/OCResourceRequest.h b/resource/include/OCResourceRequest.h index 107363e..f4b8f84 100644 --- a/resource/include/OCResourceRequest.h +++ b/resource/include/OCResourceRequest.h @@ -18,10 +18,12 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file OCResourceRequest.h - -/// @brief This file contains the declaration of classes and its members related to -/// ResourceRequest. +/** + * @file + * + * This file contains the declaration of classes and its members related to + * ResourceRequest. + */ #ifndef __OCRESOURCEREQUEST_H #define __OCRESOURCEREQUEST_H diff --git a/resource/include/OCResourceResponse.h b/resource/include/OCResourceResponse.h index 286a51a..a5a47e3 100644 --- a/resource/include/OCResourceResponse.h +++ b/resource/include/OCResourceResponse.h @@ -18,10 +18,12 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file OCResourceResponse.h - -/// @brief This file contains the declaration of classes and its members related to -/// ResourceResponse. +/** + * @file + * + * This file contains the declaration of classes and its members related to + * ResourceResponse. + */ #ifndef __OCRESOURCERESPONSE_H #define __OCRESOURCERESPONSE_H diff --git a/resource/include/OCSecurityModel.h b/resource/include/OCSecurityModel.h index 9c447aa..f43aa3b 100644 --- a/resource/include/OCSecurityModel.h +++ b/resource/include/OCSecurityModel.h @@ -18,10 +18,12 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file OCSecurityModel.h - -/// @brief This file contains the declaration of classes and its members required to provide -/// security model support. +/** + * @file + * + * This file contains the declaration of classes and its members required to + * provide security model support. + */ #ifndef __OCSECURITYMODEL_H #define __OCSECURITYMODEL_H diff --git a/resource/src/OCRepresentation.cpp b/resource/src/OCRepresentation.cpp index d1e6689..fd01b52 100644 --- a/resource/src/OCRepresentation.cpp +++ b/resource/src/OCRepresentation.cpp @@ -18,10 +18,12 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file OCRepresentation.cpp - -/// @brief This file contains the implementation of classes and its members -/// related to OCRepresentation +/** + * @file + * + * This file contains the implementation of classes and its members related + * to OCRepresentation. + */ #ifdef __ANDROID__ #include "OCAndroid.h" diff --git a/service/protocol-plugin/plugin-manager/src/Config.cpp b/service/protocol-plugin/plugin-manager/src/Config.cpp index f09565e..6f4bba8 100644 --- a/service/protocol-plugin/plugin-manager/src/Config.cpp +++ b/service/protocol-plugin/plugin-manager/src/Config.cpp @@ -18,10 +18,10 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file Config.cpp - -/// @brief - +/** + * @file + * + */ #include "Config.h" @@ -158,4 +158,4 @@ std::string Config::getPluginPath() { return ""; } -} \ No newline at end of file +} diff --git a/service/protocol-plugin/plugin-manager/src/Config.h b/service/protocol-plugin/plugin-manager/src/Config.h index 33f7f39..cf9dcf8 100644 --- a/service/protocol-plugin/plugin-manager/src/Config.h +++ b/service/protocol-plugin/plugin-manager/src/Config.h @@ -18,9 +18,10 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file Config.h - -/// @brief +/** + * @file + * + */ #ifndef __CONFIG_H #define __CONFIG_H @@ -119,4 +120,4 @@ namespace OIC }; } -#endif \ No newline at end of file +#endif diff --git a/service/protocol-plugin/plugin-manager/src/CpluffAdapter.cpp b/service/protocol-plugin/plugin-manager/src/CpluffAdapter.cpp index 3acd2f5..bdd12cb 100644 --- a/service/protocol-plugin/plugin-manager/src/CpluffAdapter.cpp +++ b/service/protocol-plugin/plugin-manager/src/CpluffAdapter.cpp @@ -18,9 +18,10 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file CpluffAdapter.cpp - -/// @brief +/** + * @file + * + */ #include "CpluffAdapter.h" @@ -592,4 +593,4 @@ void CpluffAdapter::observePluginPath(void *str) const std::string CpluffAdapter::getState(const std::string plugID) { return state_to_string(cp_get_plugin_state(m_context, plugID.c_str())); -} \ No newline at end of file +} diff --git a/service/protocol-plugin/plugin-manager/src/CpluffAdapter.h b/service/protocol-plugin/plugin-manager/src/CpluffAdapter.h index 6c108d0..9cc96d0 100644 --- a/service/protocol-plugin/plugin-manager/src/CpluffAdapter.h +++ b/service/protocol-plugin/plugin-manager/src/CpluffAdapter.h @@ -18,9 +18,10 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file CpluffAdapter.h - -/// @brief +/** + * @file + * + */ #ifndef __CPLUFFADAPTER_H #define __CPLUFFADAPTER_H diff --git a/service/protocol-plugin/plugin-manager/src/FelixAdapter.cpp b/service/protocol-plugin/plugin-manager/src/FelixAdapter.cpp index ae28ef5..a2a5637 100644 --- a/service/protocol-plugin/plugin-manager/src/FelixAdapter.cpp +++ b/service/protocol-plugin/plugin-manager/src/FelixAdapter.cpp @@ -18,9 +18,10 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file FelixAdapter.cpp - -/// @brief +/** + * @file + * + */ #include "FelixAdapter.h" #include diff --git a/service/protocol-plugin/plugin-manager/src/FelixAdapter.h b/service/protocol-plugin/plugin-manager/src/FelixAdapter.h index 0fcb98c..fd16cc2 100644 --- a/service/protocol-plugin/plugin-manager/src/FelixAdapter.h +++ b/service/protocol-plugin/plugin-manager/src/FelixAdapter.h @@ -18,9 +18,10 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file FelixAdapter.h - -/// @brief +/** + * @file + * + */ #ifndef __FELIXADAPTER_H__ #define __FELIXADAPTER_H__ diff --git a/service/protocol-plugin/plugin-manager/src/Plugin.cpp b/service/protocol-plugin/plugin-manager/src/Plugin.cpp index 7ef312c..2da8756 100644 --- a/service/protocol-plugin/plugin-manager/src/Plugin.cpp +++ b/service/protocol-plugin/plugin-manager/src/Plugin.cpp @@ -18,10 +18,10 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file Plugin.cpp - -/// @brief - +/** + * @file + * + */ #include "Plugin.h" diff --git a/service/protocol-plugin/plugin-manager/src/Plugin.h b/service/protocol-plugin/plugin-manager/src/Plugin.h index 4b5fd22..f4fd572 100644 --- a/service/protocol-plugin/plugin-manager/src/Plugin.h +++ b/service/protocol-plugin/plugin-manager/src/Plugin.h @@ -18,10 +18,10 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file Plugin.h - -/// @brief - +/** + * @file + * + */ #ifndef __Plugin_H__ #define __Plugin_H__ diff --git a/service/protocol-plugin/plugin-manager/src/PluginManager.cpp b/service/protocol-plugin/plugin-manager/src/PluginManager.cpp index 551d2d8..a620feb 100644 --- a/service/protocol-plugin/plugin-manager/src/PluginManager.cpp +++ b/service/protocol-plugin/plugin-manager/src/PluginManager.cpp @@ -18,10 +18,10 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file PluginManager.cpp - -/// @brief - +/** + * @file + * + */ #include "PluginManager.h" @@ -70,4 +70,4 @@ std::vector PluginManager::getPlugins(void) std::string PluginManager::getState(const std::string plugID) { return pluginManagerImpl->getState(plugID); -} \ No newline at end of file +} diff --git a/service/protocol-plugin/plugin-manager/src/PluginManager.h b/service/protocol-plugin/plugin-manager/src/PluginManager.h index 12c11ab..777b376 100644 --- a/service/protocol-plugin/plugin-manager/src/PluginManager.h +++ b/service/protocol-plugin/plugin-manager/src/PluginManager.h @@ -18,9 +18,10 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file PluginManager.h - -/// @brief +/** + * @file + * + */ #ifndef __PLUGINMANAGER_H #define __PLUGINMANAGER_H diff --git a/service/protocol-plugin/plugin-manager/src/PluginManagerImpl.cpp b/service/protocol-plugin/plugin-manager/src/PluginManagerImpl.cpp index ce45e22..a7fafa6 100644 --- a/service/protocol-plugin/plugin-manager/src/PluginManagerImpl.cpp +++ b/service/protocol-plugin/plugin-manager/src/PluginManagerImpl.cpp @@ -18,9 +18,10 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file PluginManagerImpl.cpp - -/// @brief +/** + * @file + * + */ #include "PluginManagerImpl.h" diff --git a/service/protocol-plugin/plugin-manager/src/PluginManagerImpl.h b/service/protocol-plugin/plugin-manager/src/PluginManagerImpl.h index 2d34ed0..553944b 100644 --- a/service/protocol-plugin/plugin-manager/src/PluginManagerImpl.h +++ b/service/protocol-plugin/plugin-manager/src/PluginManagerImpl.h @@ -18,9 +18,10 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file PluginManagerImpl.h - -/// @brief +/** + * @file + * + */ #ifndef __PLUGINMANAGERIMPL_H__ #define __PLUGINMANAGERIMPL_H__ diff --git a/service/things-manager/sdk/inc/ThingsManager.h b/service/things-manager/sdk/inc/ThingsManager.h index 2ab30f0..4c5ff34 100644 --- a/service/things-manager/sdk/inc/ThingsManager.h +++ b/service/things-manager/sdk/inc/ThingsManager.h @@ -18,10 +18,12 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file ThingsManager.h -/// -/// @brief This file contains the declaration of ThingsManager class -/// and its members related to ThingsManager. +/** + * @file + * + * This file contains the declaration of ThingsManager class and its + * members related to ThingsManager. + */ #ifndef __OC_THINGSMANAGER__ #define __OC_THINGSMANAGER__ diff --git a/service/things-manager/sdk/src/GroupManager.cpp b/service/things-manager/sdk/src/GroupManager.cpp index 411cb1d..0d761f5 100644 --- a/service/things-manager/sdk/src/GroupManager.cpp +++ b/service/things-manager/sdk/src/GroupManager.cpp @@ -18,8 +18,10 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file GroupManager.cpp -/// @brief +/** + * @file + * + */ #include "GroupManager.h" #include diff --git a/service/things-manager/sdk/src/GroupManager.h b/service/things-manager/sdk/src/GroupManager.h index a77e881..ebc7d0c 100644 --- a/service/things-manager/sdk/src/GroupManager.h +++ b/service/things-manager/sdk/src/GroupManager.h @@ -18,9 +18,12 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file GroupManager.h - -/// @brief This file contains the declaration of classes and its members related to GroupManager +/** + * @file + * + * This file contains the declaration of classes and its members related to + * GroupManager. + */ #ifndef __OC_GROUPMANAGER__ #define __OC_GROUPMANAGER__ diff --git a/service/things-manager/sdk/src/GroupSynchronization.cpp b/service/things-manager/sdk/src/GroupSynchronization.cpp index f641f4b..50d032a 100644 --- a/service/things-manager/sdk/src/GroupSynchronization.cpp +++ b/service/things-manager/sdk/src/GroupSynchronization.cpp @@ -18,8 +18,10 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file GroupSynchronization.cpp -/// @brief +/** + * @file + * + */ #include "GroupSynchronization.h" diff --git a/service/things-manager/sdk/src/GroupSynchronization.h b/service/things-manager/sdk/src/GroupSynchronization.h index fdcea60..6bd8a8d 100644 --- a/service/things-manager/sdk/src/GroupSynchronization.h +++ b/service/things-manager/sdk/src/GroupSynchronization.h @@ -18,10 +18,12 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file GroupSynchronization.h - -/// @brief This file contains the declaration of classes and -///its members related to GroupSynchronization. +/** + * @file + * + * This file contains the declaration of classes and its members related to + * GroupSynchronization. + */ #ifndef __OC_GROUPSYNCHRONIZATION__ #define __OC_GROUPSYNCHRONIZATION__ diff --git a/service/things-manager/sdk/src/ThingsConfiguration.cpp b/service/things-manager/sdk/src/ThingsConfiguration.cpp index 8b29e2e..53d64ce 100755 --- a/service/things-manager/sdk/src/ThingsConfiguration.cpp +++ b/service/things-manager/sdk/src/ThingsConfiguration.cpp @@ -18,8 +18,10 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file ThingsConfiguration.cpp -/// @brief +/** + * @file + * + */ #include #include diff --git a/service/things-manager/sdk/src/ThingsConfiguration.h b/service/things-manager/sdk/src/ThingsConfiguration.h index 79e2579..b21417e 100644 --- a/service/things-manager/sdk/src/ThingsConfiguration.h +++ b/service/things-manager/sdk/src/ThingsConfiguration.h @@ -18,10 +18,12 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file ThingsConfiguration.h - -/// @brief This file contains the declaration of classes and its members related to -/// ThingsConfiguration. +/** + * @file + * + * This file contains the declaration of classes and its members related to + * ThingsConfiguration. + */ #ifndef __OC_THINGSCONFIGURATION__ #define __OC_THINGSCONFIGURATION__ diff --git a/service/things-manager/sdk/src/ThingsDiagnostics.cpp b/service/things-manager/sdk/src/ThingsDiagnostics.cpp index b4032a3..2c1cf6c 100755 --- a/service/things-manager/sdk/src/ThingsDiagnostics.cpp +++ b/service/things-manager/sdk/src/ThingsDiagnostics.cpp @@ -18,8 +18,10 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file ThingsDiagnostics.cpp -/// @brief +/** + * @file + * + */ #include #include diff --git a/service/things-manager/sdk/src/ThingsDiagnostics.h b/service/things-manager/sdk/src/ThingsDiagnostics.h index dda9362..072f367 100644 --- a/service/things-manager/sdk/src/ThingsDiagnostics.h +++ b/service/things-manager/sdk/src/ThingsDiagnostics.h @@ -18,10 +18,12 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file ThingsDiagnostics.h - -/// @brief This file contains the declaration of classes and its members related to -/// ThingsDiagnostics. +/** + * @file + * + * This file contains the declaration of classes and its members related to + * ThingsDiagnostics. + */ #ifndef __OC_THINGSDIAGNOSTICS__ #define __OC_THINGSDIAGNOSTICS__ diff --git a/service/things-manager/sdk/src/ThingsManager.cpp b/service/things-manager/sdk/src/ThingsManager.cpp index 9009612..916e9de 100644 --- a/service/things-manager/sdk/src/ThingsManager.cpp +++ b/service/things-manager/sdk/src/ThingsManager.cpp @@ -18,7 +18,10 @@ // //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= -/// @file ThingsManager.cpp +/** + * @file + * + */ #include "ThingsManager.h" #include "GroupManager.h"