fix most of doxygen warnings and errors

openair2/UTIL/MATH/oml.h

@@ -41,14 +41,12 @@
 
 #define PI 3.14159265
 
-
-/*! \fn void set_taus_seed(unsigned int seed_type);
-* \brief initialize seeds used for the generation of taus random values
-* \param[in] initial value
-* \param[out]
-* \note
-* @ingroup  _oml
-*/
+/*! \fn set_taus_seed
+ * \brief initialize seeds used for the generation of taus random values
+ * \param[in] seed_type initial value
+ * \note
+ * @ingroup  _oml
+ */
 void set_taus_seed(unsigned int seed_type);
 
 /*! \fn inline unsigned int taus(unsigned int comp);

openair2/UTIL/OPT/probe.c

@@ -41,12 +41,10 @@
 There is different modules:
 - OAI Address
 - OAI Components
-- \ref _frame
 
 numbering:
 -# OAI Address
 -# OAI Components
--# \ref _frame
 
 The following diagram is based on graphviz (http://www.graphviz.org/), you need to install the package to view the diagram.
  *
@@ -73,11 +71,6 @@ Doxygen help and commands can be found at http://www.stack.nl/~dimitri/doxygen/c
 
 \section _arch Architecture
 
-You need to set the IMAGE_PATH in your Doxyfile
-
-\image html arch.png "Architecture"
-\image latex arch.eps "Architecture"
-
 \subsection _mac MAC
 thisis the mac
 \subsection _rlc RLC
@@ -641,4 +634,4 @@ void terminate_opt(void) {
       break;
   }
 }
-
+/** @}*/

openair2/UTIL/OTG/otg_defs.h

@@ -185,9 +185,9 @@ typedef enum {
 } VOIP_STATE;
 
 /**
- * \enum ALPHABET
+ * \enum ALPHABET_GEN
  *
- *\brief ALPHABET Alphabet type to generate random string
+ *\brief ALPHABET_GEN Alphabet type to generate random string
  *
  */
 typedef enum {
@@ -218,21 +218,6 @@ typedef enum {
   TCP_IPV6,
 } HEADER_TYPE;
 
-/**
- * \enum TRAFFIC_TYPE
- *
- * \brief HEADER_TYPE alows to identify the traffic type no specific type, m2m,etc.
- *
- */
-
-/*
-typedef enum {
-NO_TYPE=0,
-M2M_TYPE,
-}TRAFFIC_TYPE;
- */
-
-
 /*
  otg_models: definitions and structures,
  see otg_models.c for a detailed description
@@ -333,8 +318,9 @@ typedef struct {
  */
 typedef struct {
   int max_nb_frames; /*!< \brief  Max Number of frames*/
-  int application_type[NUMBER_OF_eNB_MAX + MAX_MOBILES_PER_ENB][NUMBER_OF_eNB_MAX + MAX_MOBILES_PER_ENB][MAX_NUM_APPLICATION];  /*!\brief It identify the application of the simulated traffic, could be cbr, m2m, gaming,etc*/
-  /*!\header info */
+  int application_type[NUMBER_OF_eNB_MAX + MAX_MOBILES_PER_ENB][NUMBER_OF_eNB_MAX + MAX_MOBILES_PER_ENB]
+                      [MAX_NUM_APPLICATION]; /*!\brief It identify the application of the simulated traffic, could be cbr, m2m,
+                                                gaming,etc*/
   int trans_proto[NUMBER_OF_eNB_MAX + MAX_MOBILES_PER_ENB][NUMBER_OF_eNB_MAX + MAX_MOBILES_PER_ENB][MAX_NUM_APPLICATION];   /*!\brief Transport Protocol*/
   int ip_v[NUMBER_OF_eNB_MAX + MAX_MOBILES_PER_ENB][NUMBER_OF_eNB_MAX + MAX_MOBILES_PER_ENB][MAX_NUM_APPLICATION];  /*!\brief Ip version */
   //int header_compression;         /*!\brief Specify if header compression is used or not */

openair2/UTIL/OTG/otg_rx.h

@@ -92,12 +92,11 @@ float owd_const_mobile_core(void);
 */
 float owd_const_IP_backbone(void);
 
-/*! \fn float owd_const_applicatione();
-*\brief compute the one way delay introduced in LTE/LTE-A network REF PAPER: "Latency for Real-Time Machine-to-Machine Communication in LTE-Based System Architecture"
-*\param[out] float: application delay constant
-*\note
-*@ingroup  _otg
-*/
+/*! \fn owd_const_application
+ *\brief compute the one way delay introduced in LTE/LTE-A network REF PAPER: "Latency for Real-Time Machine-to-Machine
+ *Communication in LTE-Based System Architecture" \note
+ *@ingroup  _otg
+ */
 float owd_const_application(void);
 
 

openair2/UTIL/OTG/otg_tx.h

@@ -130,9 +130,8 @@ unsigned char *header_gen(const int hdr_size);
 */
 unsigned char *payload_pkts(const int payload_size);
 
-
-/*! \fn
-char * serialize_buffer(char* const header, char* const payload, const unsigned int buffer_size, const int flag, const int flow_id, const int ctime, const int seq_num, const int hdr_type, const int state)
+/*! \fn char * serialize_buffer(char* const header, char* const payload, const unsigned int buffer_size, const int flag, const int
+flow_id, const int ctime, const int seq_num, const int hdr_type, const int state)
 * \brief serilize the packet and add otg control information
 * \param[in] char* header pointer to the header
 * \param[in] char* payload pointer to the payload
@@ -173,14 +172,6 @@ unsigned char * serialize_buffer(
 */
 int adjust_size(int size);
 
-
-/*! \fn int header_size_genint src();
-* \brief return the header size corresponding to ip version and transport protocol
-* \param[in]  the sender (src)
-* \param[out] size of packet header
-* \note
-* @ingroup  _otg
-*/
 void header_size_gen(const int src, const int dst, const int application);
 
 void init_predef_multicast_traffic(void);