From d25a7850a354ff615bcd5ec17396effc9475103b Mon Sep 17 00:00:00 2001
From: Florian Kaltenberger <florian.kaltenberger@eurecom.fr>
Date: Tue, 15 Mar 2016 21:13:12 +0100
Subject: [PATCH] added doxygen comments
---
cmake_targets/CMakeLists.txt | 2 +-
openair2/LAYER2/MAC/ff-mac-callback.h | 59 +++++++++--------
openair2/LAYER2/MAC/ff-mac-common.h | 2 +-
openair2/LAYER2/MAC/ff-mac-csched-sap.h | 2 +-
openair2/LAYER2/MAC/ff-mac-init.h | 5 ++
openair2/LAYER2/MAC/ff-mac-sched-sap.h | 2 +-
openair2/LAYER2/MAC/ff-mac.h | 84 ++++++++++++++-----------
targets/DOCS/Doxyfile | 6 ++
8 files changed, 93 insertions(+), 69 deletions(-)
diff --git a/cmake_targets/CMakeLists.txt b/cmake_targets/CMakeLists.txt
index 85be9578cb..d69347f56c 100644
--- a/cmake_targets/CMakeLists.txt
+++ b/cmake_targets/CMakeLists.txt
@@ -232,7 +232,7 @@ if (${RTAI})
set(RTAI_SOURCE sched_dlsch.c sched_rx_pdsch.c rt_wrapper.c vcd_signal_dumper.c log.c)
endif (${RTAI})
-add_boolean_option(FAPI False "Use FAPI scheduler")
+add_boolean_option(FAPI True "Use FAPI scheduler")
#############################
# ASN.1 grammar C code generation & dependancies
diff --git a/openair2/LAYER2/MAC/ff-mac-callback.h b/openair2/LAYER2/MAC/ff-mac-callback.h
index 0a75a36ac5..11c42d2ae4 100644
--- a/openair2/LAYER2/MAC/ff-mac-callback.h
+++ b/openair2/LAYER2/MAC/ff-mac-callback.h
@@ -1,27 +1,32 @@
-#ifndef FF_MAC_CALLBACK_H
-#define FF_MAC_CALLBACK_H
-
-#if defined (__cplusplus)
-extern "C" {
-#endif
-
-/* these are the callback function types from the scheduler to openair */
-
-/* sched */
-typedef void (SchedDlConfigInd_callback_t)(void *callback_data, const struct SchedDlConfigIndParameters *params);
-typedef void (SchedUlConfigInd_callback_t)(void *callback_data, const struct SchedUlConfigIndParameters *params);
-
-/* csched */
-typedef void (CschedCellConfigCnf_callback_t)(void *callback_data, const struct CschedCellConfigCnfParameters *params);
-typedef void (CschedUeConfigCnf_callback_t)(void *callback_data, const struct CschedUeConfigCnfParameters *params);
-typedef void (CschedLcConfigCnf_callback_t)(void *callback_data, const struct CschedLcConfigCnfParameters *params);
-typedef void (CschedLcReleaseCnf_callback_t)(void *callback_data, const struct CschedLcReleaseCnfParameters *params);
-typedef void (CschedUeReleaseCnf_callback_t)(void *callback_data, const struct CschedUeReleaseCnfParameters *params);
-typedef void (CschedUeConfigUpdateInd_callback_t)(void *callback_data, const struct CschedUeConfigUpdateIndParameters *params);
-typedef void (CschedCellConfigUpdateInd_callback_t)(void *callback_data, const struct CschedCellConfigUpdateIndParameters *params);
-
-#if defined (__cplusplus)
-}
-#endif
-
-#endif /* FF_MAC_CALLBACK_H */
+#ifndef FF_MAC_CALLBACK_H
+#define FF_MAC_CALLBACK_H
+
+/*!
+ * @ingroup _fapi
+ */
+
+
+#if defined (__cplusplus)
+extern "C" {
+#endif
+
+/* these are the callback function types from the scheduler to openair */
+
+/* sched */
+typedef void (SchedDlConfigInd_callback_t)(void *callback_data, const struct SchedDlConfigIndParameters *params);
+typedef void (SchedUlConfigInd_callback_t)(void *callback_data, const struct SchedUlConfigIndParameters *params);
+
+/* csched */
+typedef void (CschedCellConfigCnf_callback_t)(void *callback_data, const struct CschedCellConfigCnfParameters *params);
+typedef void (CschedUeConfigCnf_callback_t)(void *callback_data, const struct CschedUeConfigCnfParameters *params);
+typedef void (CschedLcConfigCnf_callback_t)(void *callback_data, const struct CschedLcConfigCnfParameters *params);
+typedef void (CschedLcReleaseCnf_callback_t)(void *callback_data, const struct CschedLcReleaseCnfParameters *params);
+typedef void (CschedUeReleaseCnf_callback_t)(void *callback_data, const struct CschedUeReleaseCnfParameters *params);
+typedef void (CschedUeConfigUpdateInd_callback_t)(void *callback_data, const struct CschedUeConfigUpdateIndParameters *params);
+typedef void (CschedCellConfigUpdateInd_callback_t)(void *callback_data, const struct CschedCellConfigUpdateIndParameters *params);
+
+#if defined (__cplusplus)
+}
+#endif
+
+#endif /* FF_MAC_CALLBACK_H */
diff --git a/openair2/LAYER2/MAC/ff-mac-common.h b/openair2/LAYER2/MAC/ff-mac-common.h
index a23c2c5a89..c769faceed 100644
--- a/openair2/LAYER2/MAC/ff-mac-common.h
+++ b/openair2/LAYER2/MAC/ff-mac-common.h
@@ -32,7 +32,7 @@
* \date March 2015
* \version 1.0
* \email: florian.kaltenberger@eurecom.fr
- * @ingroup _mac
+ * @ingroup _fapi
*/
diff --git a/openair2/LAYER2/MAC/ff-mac-csched-sap.h b/openair2/LAYER2/MAC/ff-mac-csched-sap.h
index 6e7a4f5711..9bc4a623e4 100644
--- a/openair2/LAYER2/MAC/ff-mac-csched-sap.h
+++ b/openair2/LAYER2/MAC/ff-mac-csched-sap.h
@@ -32,7 +32,7 @@
* \date March 2015
* \version 1.0
* \email: florian.kaltenberger@eurecom.fr
- * @ingroup _mac
+ * @ingroup _fapi
*/
#ifndef FF_MAC_CSCHED_SAP_H
diff --git a/openair2/LAYER2/MAC/ff-mac-init.h b/openair2/LAYER2/MAC/ff-mac-init.h
index 5942615c43..5487d67ead 100644
--- a/openair2/LAYER2/MAC/ff-mac-init.h
+++ b/openair2/LAYER2/MAC/ff-mac-init.h
@@ -1,6 +1,11 @@
#ifndef FF_MAC_INIT_H
#define FF_MAC_INIT_H
+/*!
+ * @ingroup _fapi
+ */
+
+
#if defined (__cplusplus)
extern "C" {
#endif
diff --git a/openair2/LAYER2/MAC/ff-mac-sched-sap.h b/openair2/LAYER2/MAC/ff-mac-sched-sap.h
index f55450c2bb..af6541f8b8 100644
--- a/openair2/LAYER2/MAC/ff-mac-sched-sap.h
+++ b/openair2/LAYER2/MAC/ff-mac-sched-sap.h
@@ -32,7 +32,7 @@
* \date March 2015
* \version 1.0
* \email: florian.kaltenberger@eurecom.fr
- * @ingroup _mac
+ * @ingroup _fapi
*/
#ifndef FF_MAC_SCHED_SAP_H
diff --git a/openair2/LAYER2/MAC/ff-mac.h b/openair2/LAYER2/MAC/ff-mac.h
index 55dac78f23..7340f3b4f5 100644
--- a/openair2/LAYER2/MAC/ff-mac.h
+++ b/openair2/LAYER2/MAC/ff-mac.h
@@ -1,38 +1,46 @@
-#ifndef FF_MAC_H
-#define FF_MAC_H
-
-/* this file contains OAI related FAPI definitions */
-
-/* this is the public view of the FAPI's OAI interface */
-typedef struct {
- void *sched; /* this is the pointer returned by SchedInit */
- /* to be used when calling FAPI functions */
-} fapi_interface_t;
-
-/* this function initializes OAI's FAPI interfacing
- * it returns the opaque pointer given by SchedInit
- */
-fapi_interface_t *init_fapi(void);
-
-/* the following functions are called by OAI
- * they wait for the corresponding callback
- * to be called by the FAPI scheduler
- */
-
-#include "ff-mac-sched-sap.h"
-#include "ff-mac-csched-sap.h"
-
-/* from SCHED */
-void SchedDlConfigInd(fapi_interface_t *, struct SchedDlConfigIndParameters* params);
-void SchedUlConfigInd(fapi_interface_t *, struct SchedUlConfigIndParameters* params);
-
-/* from CSCHED */
-void CschedCellConfigCnf(fapi_interface_t *, struct CschedCellConfigCnfParameters *params);
-void CschedUeConfigCnf(fapi_interface_t *, struct CschedUeConfigCnfParameters *params);
-void CschedLcConfigCnf(fapi_interface_t *, struct CschedLcConfigCnfParameters *params);
-void CschedLcReleaseCnf(fapi_interface_t *, struct CschedLcReleaseCnfParameters *params);
-void CschedUeReleaseCnf(fapi_interface_t *, struct CschedUeReleaseCnfParameters *params);
-void CschedUeConfigUpdateInd(fapi_interface_t *, struct CschedUeConfigUpdateIndParameters *params);
-void CschedCellConfigUpdateInd(fapi_interface_t *, struct CschedCellConfigUpdateIndParameters *params);
-
-#endif /* FF_MAC_H */
+#ifndef FF_MAC_H
+#define FF_MAC_H
+
+/** @defgroup _fapi FAPI
+ * @ingroup _mac
+ * @{
+ */
+
+
+/* this file contains OAI related FAPI definitions */
+
+/* this is the public view of the FAPI's OAI interface */
+typedef struct {
+ void *sched; /* this is the pointer returned by SchedInit */
+ /* to be used when calling FAPI functions */
+} fapi_interface_t;
+
+/* this function initializes OAI's FAPI interfacing
+ * it returns the opaque pointer given by SchedInit
+ */
+fapi_interface_t *init_fapi(void);
+
+/* the following functions are called by OAI
+ * they wait for the corresponding callback
+ * to be called by the FAPI scheduler
+ */
+
+#include "ff-mac-sched-sap.h"
+#include "ff-mac-csched-sap.h"
+
+/* from SCHED */
+void SchedDlConfigInd(fapi_interface_t *, struct SchedDlConfigIndParameters* params);
+void SchedUlConfigInd(fapi_interface_t *, struct SchedUlConfigIndParameters* params);
+
+/* from CSCHED */
+void CschedCellConfigCnf(fapi_interface_t *, struct CschedCellConfigCnfParameters *params);
+void CschedUeConfigCnf(fapi_interface_t *, struct CschedUeConfigCnfParameters *params);
+void CschedLcConfigCnf(fapi_interface_t *, struct CschedLcConfigCnfParameters *params);
+void CschedLcReleaseCnf(fapi_interface_t *, struct CschedLcReleaseCnfParameters *params);
+void CschedUeReleaseCnf(fapi_interface_t *, struct CschedUeReleaseCnfParameters *params);
+void CschedUeConfigUpdateInd(fapi_interface_t *, struct CschedUeConfigUpdateIndParameters *params);
+void CschedCellConfigUpdateInd(fapi_interface_t *, struct CschedCellConfigUpdateIndParameters *params);
+
+/*@}*/
+
+#endif /* FF_MAC_H */
diff --git a/targets/DOCS/Doxyfile b/targets/DOCS/Doxyfile
index 0d32a3ffad..ca88e8dbcd 100644
--- a/targets/DOCS/Doxyfile
+++ b/targets/DOCS/Doxyfile
@@ -772,6 +772,12 @@ INPUT = $(OPENAIR1_DIR)/PHY/defs.h \
$(OPENAIR1_DIR)/MAC_INTERFACE/defs.h \
$(OPENAIR2_DIR)/LAYER2/MAC/defs.h \
$(OPENAIR2_DIR)/LAYER2/MAC/proto.h \
+ $(OPENAIR2_DIR)/LAYER2/MAC/ff-mac-callback.h \
+ $(OPENAIR2_DIR)/LAYER2/MAC/ff-mac-common.h \
+ $(OPENAIR2_DIR)/LAYER2/MAC/ff-mac-csched-sap.h \
+ $(OPENAIR2_DIR)/LAYER2/MAC/ff-mac-sched-sap.h \
+ $(OPENAIR2_DIR)/LAYER2/MAC/ff-mac.h \
+ $(OPENAIR2_DIR)/LAYER2/MAC/ff-mac-init.h \
$(OPENAIR2_DIR)/LAYER2/RLC/rlc.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_constants.h \
--
2.26.2