fixed doxygen ff-api group labels in lte module (bug 1499)

digideskio · Sep 6, 2013 · 7f3d01b · 7f3d01b
1 parent 142714d
commit 7f3d01b
Show file tree

Hide file tree

Showing 13 changed files with 7 additions and 48 deletions.
diff --git a/src/lte/model/fdbet-ff-mac-scheduler.h b/src/lte/model/fdbet-ff-mac-scheduler.h
@@ -64,10 +64,6 @@ struct fdbetsFlowPerf_t
 
 /**
  * \ingroup ff-api
- * \defgroup FF-API FdBetFfMacScheduler
- */
-/**
- * \ingroup FdBetFfMacScheduler
  * \brief Implements the SCHED SAP and CSCHED SAP for a Frequency Domain Blind Equal Throughput scheduler
  *
  * This class implements the interface defined by the FfMacScheduler abstract class

diff --git a/src/lte/model/fdmt-ff-mac-scheduler.h b/src/lte/model/fdmt-ff-mac-scheduler.h
@@ -56,10 +56,6 @@ typedef std::vector < uint8_t > UlHarqProcessesStatus_t;
 
 /**
  * \ingroup ff-api
- * \defgroup FF-API FdMtFfMacScheduler
- */
-/**
- * \ingroup FdMtFfMacScheduler
  * \brief Implements the SCHED SAP and CSCHED SAP for a Frequency Domain Maximize Throughput scheduler
  *
  * This class implements the interface defined by the FfMacScheduler abstract class

diff --git a/src/lte/model/fdtbfq-ff-mac-scheduler.h b/src/lte/model/fdtbfq-ff-mac-scheduler.h
@@ -71,10 +71,6 @@ struct fdtbfqsFlowPerf_t
 
 /**
  * \ingroup ff-api
- * \defgroup FF-API FdTbfqFfMacScheduler
- */
-/**
- * \ingroup FdTbfqFfMacScheduler
  * \brief Implements the SCHED SAP and CSCHED SAP for a Frequency Domain Token Bank Fair Queue  scheduler
  *
  * This class implements the interface defined by the FfMacScheduler abstract class

diff --git a/src/lte/model/ff-mac-csched-sap.h b/src/lte/model/ff-mac-csched-sap.h
@@ -30,10 +30,6 @@ namespace ns3 {
 
 /**
  * \ingroup ff-api
- * \defgroup FF-API FfMacCschedSap
- */
-/**
- * \ingroup FfMacCschedSap
  * \brief Provides the CSCHED SAP
  *
  * This abstract class defines the MAC Scheduler interface specified in the

diff --git a/src/lte/model/ff-mac-sched-sap.h b/src/lte/model/ff-mac-sched-sap.h
@@ -31,10 +31,6 @@ namespace ns3 {
 
 /**
  * \ingroup ff-api
- * \defgroup FF-API FfMacSchedSap
- */
-/**
- * \ingroup FfMacSchedSap
  * \brief Provides the SCHED SAP
  *
  * This abstract class defines the MAC Scheduler interface specified in the

diff --git a/src/lte/model/ff-mac-scheduler.h b/src/lte/model/ff-mac-scheduler.h
@@ -35,6 +35,13 @@ class FfMacCschedSapProvider;
 class FfMacSchedSapProvider;
 
 /**
+ * \ingroup lte
+ * \defgroup ff-api FF MAC Schedulers
+ */
+
+/**
+ * \ingroup ff-api
+ *
  * This abstract base class identifies the interface by means of which
  * the helper object can plug on the MAC a scheduler implementation based on the
  * FF MAC Sched API.

diff --git a/src/lte/model/pf-ff-mac-scheduler.h b/src/lte/model/pf-ff-mac-scheduler.h
@@ -63,10 +63,6 @@ struct pfsFlowPerf_t
 
 /**
  * \ingroup ff-api
- * \defgroup FF-API PfFfMacScheduler
- */
-/**
- * \ingroup PfFfMacScheduler
  * \brief Implements the SCHED SAP and CSCHED SAP for a Proportional Fair scheduler
  *
  * This class implements the interface defined by the FfMacScheduler abstract class

diff --git a/src/lte/model/pss-ff-mac-scheduler.h b/src/lte/model/pss-ff-mac-scheduler.h
@@ -72,10 +72,6 @@ struct pssFlowPerf_t
 
 /**
  * \ingroup ff-api
- * \defgroup FF-API PssFfMacScheduler
- */
-/**
- * \ingroup PssFfMacScheduler
  * \brief Implements the SCHED SAP and CSCHED SAP for a Priority Set scheduler
  *
  * This class implements the interface defined by the FfMacScheduler abstract class

diff --git a/src/lte/model/rr-ff-mac-scheduler.h b/src/lte/model/rr-ff-mac-scheduler.h
@@ -50,10 +50,6 @@ typedef std::vector < uint8_t > UlHarqProcessesStatus_t;
 
 /**
  * \ingroup ff-api
- * \defgroup FF-API RrFfMacScheduler
- */
-/**
- * \ingroup RrFfMacScheduler
  * \brief Implements the SCHED SAP and CSCHED SAP for a Round Robin scheduler
  *
  * This class implements the interface defined by the FfMacScheduler abstract class

diff --git a/src/lte/model/tdbet-ff-mac-scheduler.h b/src/lte/model/tdbet-ff-mac-scheduler.h
@@ -64,10 +64,6 @@ struct tdbetsFlowPerf_t
 
 /**
  * \ingroup ff-api
- * \defgroup FF-API TdBetFfMacScheduler
- */
-/**
- * \ingroup TdBetFfMacScheduler
  * \brief Implements the SCHED SAP and CSCHED SAP for a Time Domain Blind Equal Throughput scheduler
  *
  * This class implements the interface defined by the FfMacScheduler abstract class

diff --git a/src/lte/model/tdmt-ff-mac-scheduler.h b/src/lte/model/tdmt-ff-mac-scheduler.h
@@ -56,10 +56,6 @@ typedef std::vector < uint8_t > UlHarqProcessesStatus_t;
 
 /**
  * \ingroup ff-api
- * \defgroup FF-API TdMtFfMacScheduler
- */
-/**
- * \ingroup TdMtFfMacScheduler
  * \brief Implements the SCHED SAP and CSCHED SAP for a Time Domain Maximize Throughput scheduler
  *
  * This class implements the interface defined by the FfMacScheduler abstract class

diff --git a/src/lte/model/tdtbfq-ff-mac-scheduler.h b/src/lte/model/tdtbfq-ff-mac-scheduler.h
@@ -71,10 +71,6 @@ struct tdtbfqsFlowPerf_t
 
 /**
  * \ingroup ff-api
- * \defgroup FF-API TdTbfqFfMacScheduler
- */
-/**
- * \ingroup TdTbfqFfMacScheduler
  * \brief Implements the SCHED SAP and CSCHED SAP for a Time Domain Token Bank Fair Queue  scheduler
  *
  * This class implements the interface defined by the FfMacScheduler abstract class

diff --git a/src/lte/model/tta-ff-mac-scheduler.h b/src/lte/model/tta-ff-mac-scheduler.h
@@ -56,10 +56,6 @@ typedef std::vector < uint8_t > UlHarqProcessesStatus_t;
 
 /**
  * \ingroup ff-api
- * \defgroup FF-API TtaFfMacScheduler
- */
-/**
- * \ingroup TtaFfMacScheduler
  * \brief Implements the SCHED SAP and CSCHED SAP for a Throughput to Average scheduler
  *
  * This class implements the interface defined by the FfMacScheduler abstract class