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
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/cmd_channelmod_show_channelid.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
This option asks for a model id and lists the parameters of this model. Some parameters can be then modified
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/cmd_channelmod_show_current.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
When a oai component, as the rf simulator, instanciates a channel model, the instanciation is added in the list of current models. The id of the instanciation is used when using the "show channelid" option.
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/cmd_channelmod_show_predef.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
Predefined channel model are a set of modelisation algorithm's, identified by a name, available in oai code.
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/question_setdistance_input.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags can be used in this help files as it is rendered in a div (tooltips don't work well in dialogs)
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
<ol>
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/question_show_channelid_input.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags can be used in this help files as it is rendered in a div (tooltips don't work well in dialogs)
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
channel index: channel model index in the channel modelisation module, it is printed when listing all defined models using the "show current" button.
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/rfsimu_show_models_algorithm.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
Available channel modelisation algorithm's can be listed using the "channelmod"/"show predef" command. A more convenient mechanism to select this will be implemented in a next version.
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/rfsimu_show_models_model_index.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
The model index can be used to modify a model parameter, using the "channelmod"/"show channelid" commands
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/rfsimu_show_models_model_name.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
Models parameters are defined in the oai configuration file under the section "channelmod.<channel list>". <channel list> describes the parameters for each <model name>. Several <channel list> can be defined, the loaded list is defined by the "channelmod.modellist" parameter. Model names are defined by the channel modelisation "user": for example the model "rfsmu_channel_ue0" is applied by the gNB rfsimulator on the signal received from ue0, the first connecet UE.
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/rfsimu_show_models_module_owner.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
When the rfsimulator is effectively using a channel model to modify a received signal he becomes the owner of that model.
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/scope_control_dataack.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
when enabled, back-end will stop sending data when too much data have not been acknowledge by the frontend. Currently the back-end limits to 200 the number of data messages waitting for ack.
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/softmodem_show_threadsched_nice.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
Nice value, relevant for other and batch scheduling can be changed via the "oai priority" field
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/softmodem_show_threadsched_sched_oai_priority.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
the oai priority field is used to provide the linux scheduling mode, priority and nice value in a single field.
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/softmodem_show_threadsched_priority.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
Linux priority field, relevant for real-time scheduling mode (Round-Robin or fifo) can be modified using the "oai priority" field
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/softmodem_show_threadsched_sched_policy.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
scheduling policy can be modified using the "oai priority" field.
|
||||
|
||||
Reference in New Issue
Block a user