maki/openairinterface5g
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
radio/AW2SORI/oaiori.c
+1 -8
View File
@@ -1,12 +1,5 @@
/*! \file oaiori.c
/*!
* \brief AW2S ORI API isolator
* \author Raymond Knopp
* \date 2019
* \version 0.1
* \company Eurecom
* \maintainer: raymond.knopp@eurecom.fr
* \note
* \warning
*/
#include <arpa/inet.h>
radio/AW2SORI/ori.h
-1
View File
@@ -1,5 +1,4 @@
/**
* @file ori.h
* @brief Open Radio Interface (ORI) C library header file.
* @author AW2S (http://www.aw2s.com)
* @version 1.8
radio/COMMON/common_lib.c
+1 -8
View File
@@ -19,15 +19,8 @@
* contact@openairinterface.org
*/
/*! \file common_lib.c
/*!
* \brief common APIs for different RF frontend device
* \author HongliangXU, Navid Nikaein
* \date 2015
* \version 0.2
* \company Eurecom
* \maintainer: navid.nikaein@eurecom.fr
* \note
* \warning
*/
#include <stdio.h>
#include <strings.h>
radio/COMMON/common_lib.h
+1 -8
View File
@@ -19,15 +19,8 @@
* contact@openairinterface.org
*/
/*! \file common_lib.h
/*!
* \brief common APIs for different RF frontend device
* \author HongliangXU, Navid Nikaein
* \date 2015
* \version 0.2
* \company Eurecom
* \maintainer: navid.nikaein@eurecom.fr
* \note
* \warning
*/
#ifndef COMMON_LIB_H
radio/COMMON/record_player.c
-6
View File
@@ -19,12 +19,6 @@
* contact@openairinterface.org
*/
/** record_player.c
*
* \author: Nokia bellLabs B. Mongazon F. Taburet
*
*/
#include <string.h>
#include <unistd.h>
#include <stdio.h>
radio/COMMON/record_player.h
-5
View File
@@ -21,11 +21,6 @@
* contact@openairinterface.org
*/
/** radio/COMMON/record-player.h
*
* \author: bruno.mongazon-cazavet@nokia-bell-labs.com
*/
#include <sys/mman.h>
#include <sys/types.h>
#include <sys/stat.h>
radio/ETHERNET/eth_raw.c
+1 -8
View File
@@ -19,15 +19,8 @@
* contact@openairinterface.org
*/
/*! \file ethernet_lib.c
/*!
* \brief API to stream I/Q samples over standard ethernet
* \author add alcatel Katerina Trilyraki, Navid Nikaein, Pedro Dinis, Lucio Ferreira, Raymond Knopp, Tien-Thinh Nguyen
* \date 2015
* \version 0.2
* \company Eurecom
* \maintainer: navid.nikaein@eurecom.fr
* \note
* \warning
*/
#include <arpa/inet.h>
radio/ETHERNET/eth_udp.c
+1 -8
View File
@@ -19,15 +19,8 @@
* contact@openairinterface.org
*/
/*! \file ethernet_lib.c
/*!
* \brief API to stream I/Q samples over standard ethernet
* \author add alcatel Katerina Trilyraki, Navid Nikaein, Pedro Dinis, Lucio Ferreira, Raymond Knopp
* \date 2015
* \version 0.2
* \company Eurecom
* \maintainer: navid.nikaein@eurecom.fr
* \note
* \warning
*/
// _GNU_SOURCE needed to have sched_getcpu() from sched.h
radio/ETHERNET/ethernet.md
-4
View File
@@ -3,10 +3,6 @@
This directory contains ethernet-based drivers for fronthaul. The only functional versions today are ECPRI time-domain (split 8) over UDP for AW2S and IF4.5 (split 7) for OAI RU over UDP. The RAW ethernet implementation is currently not tested and quite possibly obsolete.
## license
Author:
Raymond Knopp, EURECOM
OAI License V1.1
# Top-level
The files implement the OAI IF device interface which provides the transmit/receive (trx) functions for generic ethernet-based devices. Some minimal control-plane socket handling for IF4p5 is also provided. It comprises the following top-level functions (ethernet_lib.c) which are mapped to the OAI device structure:
radio/ETHERNET/ethernet_lib.c
+1 -8
View File
@@ -19,15 +19,8 @@
* contact@openairinterface.org
*/
/*! \file ethernet_lib.c
/*!
* \brief API to stream I/Q samples over standard ethernet
* \author add alcatel Katerina Trilyraki, Navid Nikaein, Pedro Dinis, Lucio Ferreira, Raymond Knopp
* \date 2015
* \version 0.2
* \company Eurecom
* \maintainer: navid.nikaein@eurecom.fr
* \note
* \warning
*/
#include <arpa/inet.h>
radio/ETHERNET/ethernet_lib.h
+1 -8
View File
@@ -19,15 +19,8 @@
* contact@openairinterface.org
*/
/*! \file ethernet_lib.h
/*!
* \brief API to stream I/Q samples over standard ethernet
* \author Katerina Trilyraki, Navid Nikaein
* \date 2015
* \version 0.2
* \company Eurecom
* \maintainer: navid.nikaein@eurecom.fr
* \note
* \warning
*/
#ifndef ETHERNET_LIB_H
#define ETHERNET_LIB_H
radio/ETHERNET/if_defs.h
-11
View File
@@ -19,17 +19,6 @@
* contact@openairinterface.org
*/
/*! \file radio/ETHERNET/if_defs.h
* \brief
* \author S. Sandeep Kumar, Raymond Knopp
* \date 2016
* \version 0.1
* \company Eurecom
* \email: ee13b1025@iith.ac.in, knopp@eurecom.fr
* \note
* \warning
*/
#ifndef __ETHERNET_USERSPACE_LIB_IF_DEFS__H__
#define __ETHERNET_USERSPACE_LIB_IF_DEFS__H__
radio/IRIS/iris_lib.cpp
-6
View File
@@ -1,10 +1,4 @@
/** iris_lib.cpp
*
* \authors: Rahman Doost-Mohammady : doost@rice.edu
* Clay Shepard : cws@rice.edu
*/
#include <string.h>
#include <pthread.h>
#include <unistd.h>
radio/LMSSDR/sodera_lib.cpp
-5
View File
@@ -18,11 +18,6 @@
* For more information about the OpenAirInterface (OAI) Software Alliance:
* contact@openairinterface.org
*/
/** sodera_lib.c
*
* Author: Raymond Knopp
*/
#include <vector>
#include <string>
radio/USRP/usrp_lib.cpp
-4
View File
@@ -19,10 +19,6 @@
* contact@openairinterface.org
*/
/** usrp_lib.cpp
*
* \author: HongliangXU : hong-liang-xu@agilent.com
*/
#define _LARGEFILE_SOURCE
#define _FILE_OFFSET_BITS 64
#include <string.h>
radio/fhi_72/armral_bfp_compression.c
+1 -7
View File
@@ -19,14 +19,8 @@
* contact@openairinterface.org
*/
/*! \file radio/fhi_72/armral_bfp_compression.c
/*!
* \brief BFP compression for the O-RAN 7.2 FrontHaul Interface for Arm systems using the Arm RAN Acceleration Library
* \author Romain Beurdouche
* \date 2025
* \company EURECOM
* \email romain.beurdouche@eurecom.fr
* \note ArmRAL available at https://git.gitlab.arm.com/networking/ral.git
* \warning
*/
#include "armral.h"
radio/fhi_72/armral_bfp_compression.h
+1 -7
View File
@@ -19,14 +19,8 @@
* contact@openairinterface.org
*/
/*! \file radio/fhi_72/armral_bfp_compression.h
/*!
* \brief BFP compression for the O-RAN 7.2 FrontHaul Interface for Arm systems using the Arm RAN Acceleration Library
* \author Romain Beurdouche
* \date 2025
* \company EURECOM
* \email romain.beurdouche@eurecom.fr
* \note ArmRAL available at https://git.gitlab.arm.com/networking/ral.git
* \warning
*/
#ifndef __ARMRAL_BFP_COMPRESSION_H__
radio/iqplayer/iqplayer_lib.c
-4
View File
@@ -19,10 +19,6 @@
* contact@openairinterface.org
*/
/** iqplayer_lib.cpp
*
* \author:FrancoisTaburet: francois.taburet@nokia-bell-labs.com
*/
#include <string.h>
#include <pthread.h>
#include <unistd.h>