Commit d25a7850 authored by Florian Kaltenberger's avatar Florian Kaltenberger

added doxygen comments

parent 73f92fd9
...@@ -232,7 +232,7 @@ if (${RTAI}) ...@@ -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) set(RTAI_SOURCE sched_dlsch.c sched_rx_pdsch.c rt_wrapper.c vcd_signal_dumper.c log.c)
endif (${RTAI}) 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 # ASN.1 grammar C code generation & dependancies
......
#ifndef FF_MAC_CALLBACK_H #ifndef FF_MAC_CALLBACK_H
#define FF_MAC_CALLBACK_H #define FF_MAC_CALLBACK_H
/*!
* @ingroup _fapi
*/
#if defined (__cplusplus) #if defined (__cplusplus)
extern "C" { extern "C" {
#endif #endif
......
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
* \date March 2015 * \date March 2015
* \version 1.0 * \version 1.0
* \email: florian.kaltenberger@eurecom.fr * \email: florian.kaltenberger@eurecom.fr
* @ingroup _mac * @ingroup _fapi
*/ */
......
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
* \date March 2015 * \date March 2015
* \version 1.0 * \version 1.0
* \email: florian.kaltenberger@eurecom.fr * \email: florian.kaltenberger@eurecom.fr
* @ingroup _mac * @ingroup _fapi
*/ */
#ifndef FF_MAC_CSCHED_SAP_H #ifndef FF_MAC_CSCHED_SAP_H
......
#ifndef FF_MAC_INIT_H #ifndef FF_MAC_INIT_H
#define FF_MAC_INIT_H #define FF_MAC_INIT_H
/*!
* @ingroup _fapi
*/
#if defined (__cplusplus) #if defined (__cplusplus)
extern "C" { extern "C" {
#endif #endif
......
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
* \date March 2015 * \date March 2015
* \version 1.0 * \version 1.0
* \email: florian.kaltenberger@eurecom.fr * \email: florian.kaltenberger@eurecom.fr
* @ingroup _mac * @ingroup _fapi
*/ */
#ifndef FF_MAC_SCHED_SAP_H #ifndef FF_MAC_SCHED_SAP_H
......
#ifndef FF_MAC_H #ifndef FF_MAC_H
#define FF_MAC_H #define FF_MAC_H
/** @defgroup _fapi FAPI
* @ingroup _mac
* @{
*/
/* this file contains OAI related FAPI definitions */ /* this file contains OAI related FAPI definitions */
/* this is the public view of the FAPI's OAI interface */ /* this is the public view of the FAPI's OAI interface */
...@@ -35,4 +41,6 @@ void CschedUeReleaseCnf(fapi_interface_t *, struct CschedUeReleaseCnfParameters ...@@ -35,4 +41,6 @@ void CschedUeReleaseCnf(fapi_interface_t *, struct CschedUeReleaseCnfParameters
void CschedUeConfigUpdateInd(fapi_interface_t *, struct CschedUeConfigUpdateIndParameters *params); void CschedUeConfigUpdateInd(fapi_interface_t *, struct CschedUeConfigUpdateIndParameters *params);
void CschedCellConfigUpdateInd(fapi_interface_t *, struct CschedCellConfigUpdateIndParameters *params); void CschedCellConfigUpdateInd(fapi_interface_t *, struct CschedCellConfigUpdateIndParameters *params);
/*@}*/
#endif /* FF_MAC_H */ #endif /* FF_MAC_H */
...@@ -772,6 +772,12 @@ INPUT = $(OPENAIR1_DIR)/PHY/defs.h \ ...@@ -772,6 +772,12 @@ INPUT = $(OPENAIR1_DIR)/PHY/defs.h \
$(OPENAIR1_DIR)/MAC_INTERFACE/defs.h \ $(OPENAIR1_DIR)/MAC_INTERFACE/defs.h \
$(OPENAIR2_DIR)/LAYER2/MAC/defs.h \ $(OPENAIR2_DIR)/LAYER2/MAC/defs.h \
$(OPENAIR2_DIR)/LAYER2/MAC/proto.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/rlc.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_constants.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_constants.h \
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment