Remove most doxygen file-level commands, copyrights, and authors

Remove the \file directive, as it is always superfluous  because the
current file is implicit [1]:

> If the file name is omitted (i.e. the line after \file is left blank)
> then the documentation block that contains the \file command will belong
> to the file it is located in.

Author names and e-mails are not relevant for us: it can always be
inferred from git blame, and is often outdated.

Eurecom code has been contributed and was under OAI PL v1.0/v1.1.

For the cpack package contact: put generic email address that is
independent of an individual and that will remain reachable.

[1] https://www.doxygen.nl/manual/commands.html#cmdfile
This commit is contained in:
Robert Schmidt
2026-03-27 14:52:47 +01:00
parent 9c7f174124
commit 6ae4ec37ca
897 changed files with 977 additions and 5972 deletions
+1 -6
View File
@@ -19,14 +19,9 @@
* contact@openairinterface.org
*/
/*! \file cli.c
/*!
* \brief oai main cli core
* \author Navid Nikaein
* \date 2011 - 2014
* \version 0.1
* \warning This component can be runned only in user-space
* @ingroup util
*/
+4 -8
View File
@@ -19,14 +19,10 @@
* contact@openairinterface.org
*/
/*! \file cli.h
* \brief cli interface header file
* \author Navid Nikaein
* \date 2011 - 2014
* \version 0.1
* \warning This component can be runned only in the user-space
* @ingroup util
*/
/*!
* \brief cli interface header file
* @ingroup util
*/
#ifndef __CLI_H__
+2 -7
View File
@@ -19,14 +19,9 @@
* contact@openairinterface.org
*/
/*! \file cli_cmd.c
* \brief oai cli commands
* \author Navid Nikaein
* \date 2011 - 2014
* \version 0.1
* \warning This component can be runned only in user-space
/*!
* \brief oai cli commands
* @ingroup util
*/
+4 -8
View File
@@ -19,14 +19,10 @@
* contact@openairinterface.org
*/
/*! \file cli_if.h
* \brief cli interface
* \author Navid Nikaein
* \date 2011 - 2014
* \version 0.1
* \warning This component can be runned only in the user-space
* @ingroup util
*/
/*!
* \brief cli interface
* @ingroup util
*/
#ifndef __CLI_IF_H__
# define __CLI_IF_H__
+4 -9
View File
@@ -19,15 +19,10 @@
* contact@openairinterface.org
*/
/*! \file cli_server.c
* \brief oai cli server side implementation
* \author Navid Nikaein
* \date 2011 - 2014
* \version 0.1
* \warning This component can be runned only in user-space
* @ingroup util
*/
/*!
* \brief oai cli server side implementation
* @ingroup util
*/
#include <pthread.h>
#include <stdio.h>
#include <errno.h>
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file oml.c
* \brief Data structure for distribution libraries
* \author N. Nikaein and A. Hafsaoui
* \date 2011 - 2014
* \version 1.0
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note
* \warning
*/
/*!
* \brief Data structure for distribution libraries
*/
#include <stdio.h>
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file oml.h
* \brief Data structure for OML
* \author N. Nikaein and A. Hafsaoui
* \date 2011
* \version 1.0
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note
* \warning
*/
/*!
* \brief Data structure for OML
*/
#ifndef __OML_H__
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file OMG.c
* \brief Main function containing the OMG interface
* \author M. Mahersi, J. Harri, N. Nikaein,
* \date 2011
* \version 0.1
* \company Eurecom
* \email:
* \note
* \warning
*/
/*!
* \brief Main function containing the OMG interface
*/
#include <unistd.h>
#include <stdio.h>
-10
View File
@@ -19,16 +19,6 @@
* contact@openairinterface.org
*/
/*! \file grid.c
* \brief
* \author S. Gashaw, N. Nikaein, J. Harri
* \date 2014
* \version 0.1
* \company Eurecom
* \email:
* \note
* \warning
*/
#include <stdio.h>
#include <stdlib.h>
#include <time.h>
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file job.c
* \brief handle jobs for future nodes' update
* \author S. Gashaw, M. Mahersi, J. Harri, N. Nikaein,
* \date 2014
* \version 0.1
* \company Eurecom
* \email:
* \note
* \warning
*/
/*!
* \brief handle jobs for future nodes' update
*/
#include <unistd.h>
#include <stdio.h>
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file mobility_parser.c
* \brief A parser for trace-based mobility information (parsed from a file)
* \author S. Gashaw, N. Nikaein, J. Harri
* \date 2014
* \version 0.1
* \company EURECOM
* \email:
* \note
* \warning
*/
/*!
* \brief A parser for trace-based mobility information (parsed from a file)
*/
#include <stdio.h>
#include <string.h>
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file mobility_parser.h
* \brief A parser for trace-based mobility information (parsed from a file)
* \author S. Uppoor
* \date 2011
* \version 0.1
* \company INRIA
* \email: sandesh.uppor@inria.fr
* \note
* \warning
*/
/*!
* \brief A parser for trace-based mobility information (parsed from a file)
*/
#ifndef MOBILITY_PARSER_H_
#define MOBILITY_PARSER_H_
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file OMG.c
* \brief Main function containing the OMG API to oaisim or any other simulator/emulator
* \author S. Gashaw, N. Nikaein, J. Harri
* \date 2011 - 2014
* \version 0.1
* \company Eurecom
* \email:
* \note
* \warning
*/
/*!
* \brief Main function containing the OMG API to oaisim or any other simulator/emulator
*/
#include <unistd.h>
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file OMG.h
* \brief Prototypes of OMG APIs
* \author M. Mahersi, N. Nikaein, J. Harri
* \date 2011 - 2014
* \version 0.1
* \company Eurecom
* \email:
* \note
* \warning
*/
/*!
* \brief Prototypes of OMG APIs
*/
#ifndef __OMG_H_
#define __OMG_H_
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file omg_hashtable.c
* \brief A 'C' implementation of a hashtable
* \author S. Uppoor
* \date 2011
* \version 0.1
* \company INRIA
* \email: sandesh.uppor@inria.fr
* \note
* \warning
*/
/*!
* \brief A 'C' implementation of a hashtable
*/
#include "omg_hashtable.h"
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file omg_hashtable.h
* \brief A 'C' implementation of a hashtable
* \author S. Uppoor
* \date 2011
* \version 0.1
* \company INRIA
* \email: sandesh.uppor@inria.fr
* \note
* \warning
*/
/*!
* \brief A 'C' implementation of a hashtable
*/
#ifndef _HASHTABLE_H
#define _HASHTABLE_H
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file rwalk.c
* \brief random walk mobility generator
* \author S. Gashaw, N. Nikaein, J. Harri, M. Mahersi
* \date 2014
* \version 0.1
* \company Eurecom
* \email:
* \note
* \warning
*/
/*!
* \brief random walk mobility generator
*/
#include <stdio.h>
#include <stdlib.h>
#include <time.h>
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file rwp.c
* \brief random waypoint mobility generator
* \author M. Mahersi, N. Nikaein, J. Harri
* \date 2011
* \version 0.1
* \company Eurecom
* \email:
* \note
* \warning
*/
/*!
* \brief random waypoint mobility generator
*/
#include <stdio.h>
#include <stdlib.h>
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file rwalk.c
* \brief static mobility generator
* \author M. Mahersi, N. Nikaein, J. Harri
* \date 2011
* \version 0.1
* \company Eurecom
* \email:
* \note
* \warning
*/
/*!
* \brief static mobility generator
*/
#include <unistd.h>
#include <stdio.h>
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file steadystaterwp.c
* \brief random waypoint mobility generator
* \author S. Gashaw, J. Harri, N. Nikaein,
* \date 2014
* \version 0.1
* \company Eurecom
* \email:
* \note
* \warning
*/
/*!
* \brief random waypoint mobility generator
*/
#include <stdio.h>
#include <stdlib.h>
+2 -7
View File
@@ -19,15 +19,10 @@
* contact@openairinterface.org
*/
/*! \file steadystaterwp.h
/*!
* \brief random waypoint mobility generator
* \date 2014
* \version 0.1
* \company Eurecom
* \email:
* \note
* \warning
*/
#ifndef STEADYSTATERWP_H_
#define STEADYSTATERWP_H_
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file trace.c
* \brief The trace-based mobility model for OMG/OAI (mobility is statically imported from a file)
* \author S. Gashaw, N. Nikaein, J. Harri
* \date 2014
* \version 0.1
* \company EURECOM
* \email:
* \note
* \warning
*/
/*!
* \brief The trace-based mobility model for OMG/OAI (mobility is statically imported from a file)
*/
#include <stdio.h>
#include <stdlib.h>
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file trace.h
* \brief The trace-based mobility model for OMG/OAI (mobility is statically imported from a file)
* \author S. Uppoor
* \date 2011
* \version 0.1
* \company INRIA
* \email: sandesh.uppor@inria.fr
* \note
* \warning
*/
/*!
* \brief The trace-based mobility model for OMG/OAI (mobility is statically imported from a file)
*/
#ifndef TRACE_H_
#define TRACE_H_
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file hashtable.c
* \brief A 'C' implementation of a hashtable
* \author S. Gashaw, N. Nikaein, J. Harri
* \date 2014
* \version 0.1
* \company EURECOM
* \email:
* \note
* \warning
*/
/*!
* \brief A 'C' implementation of a hashtable
*/
#include <stdio.h>
#include "trace_hashtable.h"
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file trace_hashtable.h
* \brief A 'C' implementation of a hashtable
* \author S. Uppoor
* \date 2011
* \version 0.1
* \company INRIA
* \email: sandesh.uppor@inria.fr
* \note
* \warning
*/
/*!
* \brief A 'C' implementation of a hashtable
*/
#ifndef _TRACE_HASHTABLE_H
#define _TRACE_HASHTABLE_H
+3 -8
View File
@@ -19,14 +19,9 @@
* contact@openairinterface.org
*/
/*! \file communicationthread.cpp
* \brief this thread is to process the communication between the simulator and the visualisor
* \author M. Mosli
* \date 2012
* \version 0.1
* \company Eurecom
* \email: mosli@eurecom.fr
*/
/*!
* \brief this thread is to process the communication between the simulator and the visualisor
*/
#include "communicationthread.h"
+3 -8
View File
@@ -19,14 +19,9 @@
* contact@openairinterface.org
*/
/*! \file communicationthread.h
* \brief this thread is to process the communication between the simulator and the visualisor
* \author M. Mosli
* \date 2012
* \version 0.1
* \company Eurecom
* \email: mosli@eurecom.fr
*/
/*!
* \brief this thread is to process the communication between the simulator and the visualisor
*/
#ifndef COMMUNICATIONTHREAD_H
#define COMMUNICATIONTHREAD_H
+3 -8
View File
@@ -19,14 +19,9 @@
* contact@openairinterface.org
*/
/*! \file mywindow.cpp
* \brief manages the window and its components
* \author M. Mosli
* \date 2012
* \version 0.1
* \company Eurecom
* \email: mosli@eurecom.fr
*/
/*!
* \brief manages the window and its components
*/
#include "mywindow.h"
#include "communicationthread.h"
+3 -8
View File
@@ -19,14 +19,9 @@
* contact@openairinterface.org
*/
/*! \file mywindow.h
* \brief manages the window and its components
* \author M. Mosli
* \date 2012
* \version 0.1
* \company Eurecom
* \email: mosli@eurecom.fr
*/
/*!
* \brief manages the window and its components
*/
#ifndef MYWINDOW_H
#define MYWINDOW_H
+3 -8
View File
@@ -19,14 +19,9 @@
* contact@openairinterface.org
*/
/*! \file omv.cpp
* \brief openair mobility visualisor
* \author M. Mosli
* \date 2012
* \version 0.1
* \company Eurecom
* \email: mosli@eurecom.fr
*/
/*!
* \brief openair mobility visualisor
*/
#include "mywindow.h"
#include <stdlib.h>
+3 -8
View File
@@ -19,14 +19,9 @@
* contact@openairinterface.org
*/
/*! \file openglwidget.cpp
* \brief area devoted to draw the nodes and their connections
* \author M. Mosli
* \date 2012
* \version 0.1
* \company Eurecom
* \email: mosli@eurecom.fr
*/
/*!
* \brief area devoted to draw the nodes and their connections
*/
#include "openglwidget.h"
#include <GL/glu.h>
+3 -8
View File
@@ -19,14 +19,9 @@
* contact@openairinterface.org
*/
/*! \file openglwidget.cpp
* \brief area devoted to draw the nodes and their connections
* \author M. Mosli
* \date 2012
* \version 0.1
* \company Eurecom
* \email: mosli@eurecom.fr
*/
/*!
* \brief area devoted to draw the nodes and their connections
*/
#ifndef OPENGLWIDGET_H
+2 -7
View File
@@ -19,13 +19,8 @@
* contact@openairinterface.org
*/
/*! \file structures.h
* \brief structures used for the
* \author M. Mosli
* \date 2012
* \version 0.1
* \company Eurecom
* \email: mosli@eurecom.fr
/*!
* \brief structures used for the
*/
#ifndef STRUCTURES_H
-8
View File
@@ -29,14 +29,6 @@
* SUCH DAMAGE
*/
/*! \file probe.c
* \brief
* \author navid nikaein
* \date 2010-2012
* \version 1.0
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
*/
/** @defgroup _oai System definitions
There is different modules:
- OAI Address
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file main.c
* \brief main program for OTG CX + RX
* \author A. Hafsaoui
* \date 2011
* \version 0.1
* \company Eurecom
* \email: openair_tech@eurecom.fr
* \note
* \warning
*/
/*!
* \brief main program for OTG CX + RX
*/
#include <unistd.h>
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file otg.c
* \brief common function for otc tx and rx
* \author N. Nikaein and A. Hafsaoui
* \date 2011
* \version 0.1
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note
* \warning
*/
/*!
* \brief common function for otc tx and rx
*/
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file otg.h
* \brief Data structure and functions for OTG
* \author N. Nikaein and A. Hafsaoui
* \date 2011
* \version 1.0
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note
* \warning
*/
/*!
* \brief Data structure and functions for OTG
*/
#ifndef __OTG_H__
+3 -11
View File
@@ -19,17 +19,9 @@
* contact@openairinterface.org
*/
/*! \file otg_config.h main used structures
* \brief otg structure
* \author Navid Nikaein and A. Hafsaoui
* \date 2011 - 2014
* \version 0.1
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note
* \warning
*/
/*!
* \brief otg structure
*/
#ifndef __OTG_CONFIG_H__
# define __OTG_CONFIG_H__
+1 -8
View File
@@ -19,15 +19,8 @@
* contact@openairinterface.org
*/
/*! \file otg_defs.h main used structures
/*!
* \brief otg structure
* \author N. Nikaein and A. Hafsaoui
* \date 2011
* \version 0.1
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note
* \warning
*/
#ifndef __OTG_DEFS_H__
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file otg_externs.h
* \brief extern parameters
* \author n. nikaein A. Hafsaoui
* \date 2012
* \version 1.0
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note
* \warning
*/
/*!
* \brief extern parameters
*/
#ifndef __OTG_EXTERNS_H__
# define __OTG_EXTERNS_H__
+3 -11
View File
@@ -19,17 +19,9 @@
* contact@openairinterface.org
*/
/*! \file otg_config.h main used structures
* \brief otg structure
* \author A. Hafsaoui and Navid Nikaein
* \date 2011
* \version 0.1
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note
* \warning
*/
/*!
* \brief otg structure
*/
#include "otg_form.h"
#include "otg_externs.h"
+3 -11
View File
@@ -19,17 +19,9 @@
* contact@openairinterface.org
*/
/*! \file otg_kpi.c main used funstions to compute KPIs
* \brief define KPIs to compute for performance analysis
* \author Navid Nikaein and A. Hafsaoui
* \date 2012
* \version 0.1
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note
* \warning
*/
/*!
* \brief define KPIs to compute for performance analysis
*/
unsigned int start_log_latency=0;
unsigned int start_log_latency_bg=0;
+3 -11
View File
@@ -19,17 +19,9 @@
* contact@openairinterface.org
*/
/*! \file otg_kpi.h functions to compute OTG KPIs
* \brief desribe function for KPIs computation
* \author navid nikaein and A. Hafsaoui
* \date 2012
* \version 0.1
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note
* \warning
*/
/*!
* \brief desribe function for KPIs computation
*/
#ifndef __OTG_KPI_H__
# define __OTG_KPI_H__
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file otg_models.c
* \brief function containing the OTG TX traffic generation functions
* \author M. Laner and navid nikaein
* \date 2013
* \version 0.1
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note
* \warning
*/
/*!
* \brief function containing the OTG TX traffic generation functions
*/
#include "UTIL/MATH/oml.h"
#include "otg_models.h"
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file otg_models.h
* \brief Data structure and functions for OTG
* \author M. Laner and navid nikaein
* \date 2013
* \version 1.0
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note
* \warning
*/
/*!
* \brief Data structure and functions for OTG
*/
#ifndef __OTG_MODELS_H__
# define __OTG_MODELS_H__
+1 -8
View File
@@ -19,15 +19,8 @@
* contact@openairinterface.org
*/
/*! \file otg_rx.c
/*!
* \brief function containing the OTG traffic generation functions
* \author Navid Nikaein and A. Hafsaoui
* \date 2011
* \version 0.1
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note
* \warning
*/
#include "otg_rx.h"
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file otg_rx.h
* \brief Data structure and functions for OTG receiver
* \author navid nikaein A. Hafsaoui
* \date 2011
* \version 1.0
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note
* \warning
*/
/*!
* \brief Data structure and functions for OTG receiver
*/
#ifndef __OTG_RX_H__
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file otg_rx_socket.c
* \brief function containing the OTG RX traffic generation functions with sockets
* \author A. Hafsaoui
* \date 2012
* \version 0.1
* \company Eurecom
* \email: openair_tech@eurecom.fr
* \note
* \warning
*/
/*!
* \brief function containing the OTG RX traffic generation functions with sockets
*/
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file otg_rx_socket.h
* \brief brief explain how this block is organized, and how it works: OTG RX traffic generation functions with sockets
* \author A. Hafsaoui
* \date 2012
* \version 0.1
* \company Eurecom
* \email: openair_tech@eurecom.fr
* \note
* \warning
*/
/*!
* \brief brief explain how this block is organized, and how it works: OTG RX traffic generation functions with sockets
*/
#ifndef __OTG_RX_SOCKET_H__
#define __OTG_RX_SOCKET_H__
+1 -8
View File
@@ -19,15 +19,8 @@
* contact@openairinterface.org
*/
/*! \file otg_tx.c
/*!
* \brief function containing the OTG TX traffic generation functions
* \author N. Nikaein and A. Hafsaoui
* \date 2011
* \version 0.1
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note
* \warning
*/
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file otg_tx.h
* \brief Data structure and functions for OTG
* \author N. Nikaein and A. Hafsaoui
* \date 2011
* \version 1.0
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note
* \warning
*/
/*!
* \brief Data structure and functions for OTG
*/
#ifndef __OTG_TX_H__
# define __OTG_TX_H__
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file otg_tx_socket.c
* \brief function containing the OTG TX traffic generation functions with sockets
* \author A. Hafsaoui
* \date 2011
* \version 0.1
* \company Eurecom
* \email: openair_tech@eurecom.fr
* \note
* \warning
*/
/*!
* \brief function containing the OTG TX traffic generation functions with sockets
*/
#include "otg_tx_socket.h"
#include "otg_vars.h"
+3 -10
View File
@@ -19,16 +19,9 @@
* contact@openairinterface.org
*/
/*! \file otg_tx_socket.h
* \brief brief explain how this block is organized, and how it works: OTG TX traffic generation functions with sockets
* \author A. Hafsaoui
* \date 2012
* \version 0.1
* \company Eurecom
* \email: openair_tech@eurecom.fr
* \note
* \warning
*/
/*!
* \brief brief explain how this block is organized, and how it works: OTG TX traffic generation functions with sockets
*/
#ifndef __OTG_TX_SOCKET_H__
#define __OTG_TX_SOCKET_H__
-10
View File
@@ -19,16 +19,6 @@
* contact@openairinterface.org
*/
/*! \file otg_vars.h
* \brief Global structure
* \author navid nikaein and A. Hafsaoui
* \date 2011
* \version 1.0
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note
* \warning
*/
#ifndef __OTG_VARS_H__
# define __OTG_VARS_H__