Commit b9a68b53 authored by Jon A. Cruz's avatar Jon A. Cruz Committed by Patrick Lankswert

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: default avatarJon A. Cruz <jonc@osg.samsung.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/461Tested-by: default avatarjenkins-iotivity <jenkins-iotivity@opendaylight.org>
Reviewed-by: default avatarPatrick Lankswert <patrick.lankswert@intel.com>
parent 58dd63b2
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,8 +19,10 @@
******************************************************************/
/**
* @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_
......
/******************************************************************
/* ****************************************************************
*
* 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_
......
/******************************************************************
/* ****************************************************************
*
* 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_
......
/******************************************************************
/* ****************************************************************
*
* 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_
......
/******************************************************************
/* ****************************************************************
*
* 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_
......
/******************************************************************
/* ****************************************************************
*
* 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"
......
/******************************************************************
/* ****************************************************************
*
* 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
......@@ -18,8 +19,9 @@
******************************************************************/
/**
* @file uthreadpool.c
* @brief This file provides APIs related to thread pool
* @file
*
* This file provides APIs related to thread pool.
*/
#include "uthreadpool.h"
......
/******************************************************************
/* ****************************************************************
*
* 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_
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,8 +19,9 @@
******************************************************************/
/**
* @file caadapterutils.h
* @brief This file contains common utility function for CA transport adaptors.
* @file
*
* This file contains common utility function for CA transport adaptors.
*/
#ifndef _CA_ADAPTER_UTILS_H_
......
/******************************************************************
/* ****************************************************************
*
* 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.
* @file
*
* This file contains the APIs for EDR adapters.
*/
#ifndef __CA_EDRADAPTER_H_
#define __CA_EDRADAPTER_H_
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -17,10 +17,13 @@
* limitations under the License.
*
******************************************************************/
/**
* @file caedradapter_singlethread.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_SINGLETHREAD_H_
#define __CA_EDRADAPTER_SINGLETHREAD_H_
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,9 +19,11 @@
******************************************************************/
/**
* @file caedrcore.h
* @brief This file contains the APIs for BT EDR communications.
* @file
*
* This file contains the APIs for BT EDR communications.
*/
#ifndef __CA_EDRCORE_H_
#define __CA_EDRCORE_H_
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,8 +19,10 @@
******************************************************************/
/**
* @file caedrinterface.h
* @brief This file provides APIs for EDR adapter - client, server, network monitor modules
* @file
*
* This file provides APIs for EDR adapter - client, server, network monitor
* modules.
*/
#ifndef __CA_EDR_INTERFACE_H_
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,9 +19,11 @@
******************************************************************/
/**
* @file caedrcore.h
* @brief This file contains the APIs for BT EDR communications.
* @file
*
* This file contains the APIs for BT EDR communications.
*/
#ifndef __CA_EDRCORE_H_
#define __CA_EDRCORE_H_
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,9 +19,11 @@
******************************************************************/
/**
* @file caedrutils.h
* @brief This file contains the APIs for BT communications.
*/
* @file
*
* This file contains the APIs for BT communications.
*/
#ifndef __CA_EDRUTILES_H_
#define __CA_EDRUTILES_H_
......
/******************************************************************
/* ****************************************************************
*
* 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__
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,9 +19,11 @@
******************************************************************/
/**
* @file caethernetadapter_singlethread.h
* @brief This file contains the APIs for Ethernet Adapter.
* @file
*
* This file contains the APIs for Ethernet Adapter.
*/
#ifndef __CA_ETHERNET_ADAPTER_SINGLETHREAD_H__
#define __CA_ETHERNET_ADAPTER_SINGLETHREAD_H__
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,8 +19,9 @@
******************************************************************/
/**
* @file caethernetinterface.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_INTERFACE_H_
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,8 +19,9 @@
******************************************************************/
/**
* @file caethernetinterface_singlethread.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_INTERFACE_SINGLETHREAD_H_
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,8 +19,9 @@
******************************************************************/
/**
* @file caadapterutils.h
* @brief This file contains common utility function for CA transport adaptors.
* @file
*
* This file contains common utility function for CA transport adaptors.
*/
#ifndef __CA_INTERFACE_CONTROLLER_H_
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -17,9 +17,11 @@
* limitations under the License.
*
******************************************************************/
/**
* @file cainterfacecontroller_singlethread.h
* @brief This file contains the APIs for the interface controller
* @file
*
* This file contains the APIs for the interface controller.
*/
#ifndef __CA_INTERFACE_CONTROLLER_SINGLETHREAD_H_
......
/******************************************************************
/* ****************************************************************
*
* 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_
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,9 +19,11 @@
******************************************************************/
/**
* @file caleadapter_singlethread.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_SINGLETHREAD_H_
#define _CA_LEADAPTER_SINGLETHREAD_H_
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,9 +19,11 @@
******************************************************************/
/**
* @file calecore.h
* @brief This file contains the APIs for BT LE communications.
* @file
*
* This file contains the APIs for BT LE communications.
*/
#ifndef __CA_LECORE_H_
#define __CA_LECORE_H_
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,8 +19,9 @@
******************************************************************/
/**
* @file caleinterface.h
* @brief This file provides APIs for BLE modules
* @file
*
* This file provides APIs for BLE modules.
*/
#ifndef _CA_LE_INTERFACE_H_
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,8 +19,9 @@
******************************************************************/
/**
* @file caleinterface_singlethread.h
* @brief This file provides APIs for BLE modules
* @file
*
* This file provides APIs for BLE modules.
*/
#ifndef _CA_LE_INTERFACE_SINGLETHREAD_H_
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,9 +19,11 @@
******************************************************************/
/**
* @file calenwmonitor.h
* @brief This file contains the APIs for BT LE communications.
*/
* @file
*
* This file contains the APIs for BT LE communications.
*/
#ifndef __CA_LENWMONITOR_H_
#define __CA_LENWMONITOR_H_
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,9 +19,11 @@
******************************************************************/
/**
* @file calecore.h
* @brief This file contains the APIs for BT LE communications.
*/
* @file
*
* This file contains the APIs for BT LE communications.
*/
#ifndef __CA_LESERVER_H_
#define __CA_LESERVER_H_
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,9 +19,11 @@
******************************************************************/
/**
* @file caleutils.h
* @brief This file contains the APIs for BT LE communications.
*/
* @file
*
* This file contains the APIs for BT LE communications.
*/
#ifndef __CA_LEUTILES_H_
#define __CA_LEUTILES_H_
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -17,8 +17,10 @@
* limitations under the License.
*
******************************************************************/
/**
* @file camessagehandler.h
* @file
*
* @brief This file contains message functionality.
*/
......
/******************************************************************
/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
......@@ -19,8 +19,9 @@
******************************************************************/
/**
* @file camessagehandler_singlethread.h
* @brief This file contains message functionality.
* @file
*
* This file contains message functionality.
*/