Commit 5161cb70 authored by Florian Kaltenberger's avatar Florian Kaltenberger

small update to documentation

parent 31412e48
...@@ -10,12 +10,14 @@ ...@@ -10,12 +10,14 @@
/** /**
* @mainpage LTE MAC Scheduler Interface * @mainpage LTE MAC Scheduler Interface
* This is an implementation of FemtoForum (today <a href="http://www.smallcellforum.org">Small Cell Forum</a>) originated LTE MAC Scheduler Interface v1.11. * This document specifies the SOLDER FAPI 2.0, which is an extension of the LTE MAC Scheduler Interface v1.11 originally defined by the FemtoForum (today <a href="http://www.smallcellforum.org">Small Cell Forum</a>).
* Current version of the API was developed by <a href="http://www.is-wireless.com">IS-Wireless</a> and <a href="http://www.eurecom.fr/en">Eurecom</a> and is an extension of original FAPI. Extensions are: * The current version of the API was developed by <a href="http://www.is-wireless.com">IS-Wireless</a> and <a href="http://www.eurecom.fr/en">Eurecom</a> in the context of the EU FP7 project <a href="http://ict-solder.eu">SOLDER</a>. Extensions are:
* @li support for Carrier Aggregation * @li support for Carrier Aggregation
* @li improved CQI report structures * @li improved CQI report structures
* @li bug fixes * @li bug fixes
* *
* This document is an executable specification, meaning that it has been generated automatically from source code. The source code is open-source and is available from the <a href="http://www.openairinterface.org">OpenAirInterface.org</a> project availiable from the <a href="https://gitlab.eurecom.fr/oai/openairinterface5g">Eurecom gitlab server</a> (branch feature-31-ff-scheduler-api).
* An example scheduler that works with this FAPI is available from <a href="https://www.is-wireless.com/protocols/lte-enb-scheduler">IS-Wireless</a>.
* <hr> * <hr>
* @section fapiOrigDoc_sec Original FAPI documentation * @section fapiOrigDoc_sec Original FAPI documentation
* This section contains the copy of FAPI documentation that was included in the original "LTE MAC Scheduler Interface v1.11" document by FemtoForum (Document number: FF_Tech_001_v1.11 * This section contains the copy of FAPI documentation that was included in the original "LTE MAC Scheduler Interface v1.11" document by FemtoForum (Document number: FF_Tech_001_v1.11
......
...@@ -38,7 +38,7 @@ PROJECT_NAME = "FAPI" ...@@ -38,7 +38,7 @@ PROJECT_NAME = "FAPI"
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
# control system is used. # control system is used.
PROJECT_NUMBER = "1.0.0" PROJECT_NUMBER = "2.0.0"
# Using the PROJECT_BRIEF tag one can provide an optional one line description # Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a # for a project that appears at the top of each page and should give viewer a
...@@ -51,7 +51,7 @@ PROJECT_BRIEF = "Small Cell Forum originated LTE MAC scheduler API" ...@@ -51,7 +51,7 @@ PROJECT_BRIEF = "Small Cell Forum originated LTE MAC scheduler API"
# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
# to the output directory. # to the output directory.
PROJECT_LOGO = PROJECT_LOGO = "images/solder.png"
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is # into which the generated documentation will be written. If a relative path is
......
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