Final updates to correct doxygen warnings for the lte module

Final updates to correct doxygen warnings for the lte module

[Biljana Bojović, 2017-03-08 01:49:42]

First part review.

https://codereview.appspot.com/311650043/diff/30209/src/lte/examples/lena-dua...
File src/lte/examples/lena-dual-stripe.cc (right):

https://codereview.appspot.com/311650043/diff/30209/src/lte/examples/lena-dua...
src/lte/examples/lena-dual-stripe.cc:51: * FemtocellBlockAllocator
Class that takes care of installing blocks of the buildings in a given area.
Buildings are installed in pairs as in dual stripe scenario.

https://codereview.appspot.com/311650043/diff/30209/src/lte/examples/lena-dua...
src/lte/examples/lena-dual-stripe.cc:57: * Block allocator function
constructor

https://codereview.appspot.com/311650043/diff/30209/src/lte/examples/lena-dua...
src/lte/examples/lena-dual-stripe.cc:64: * Create function
Function that creates building blocks.

https://codereview.appspot.com/311650043/diff/30209/src/lte/helper/lte-helper.h
File src/lte/helper/lte-helper.h (right):

https://codereview.appspot.com/311650043/diff/30209/src/lte/helper/lte-helper...
src/lte/helper/lte-helper.h:465: uint8_t ActivateDedicatedEpsBearer
(NetDeviceContainer ueDevices, EpsBearer bearer, Ptr<EpcTft> tft);
"\returns bearer ID"

https://codereview.appspot.com/311650043/diff/30209/src/lte/helper/lte-helper...
src/lte/helper/lte-helper.h:473: * \returns bearer ID or 0 if not found
\returns bearer ID

https://codereview.appspot.com/311650043/diff/30209/src/lte/helper/lte-helper...
src/lte/helper/lte-helper.h:666: * Get downlink spectrum channel
of a given carrier

https://codereview.appspot.com/311650043/diff/30209/src/lte/helper/lte-helper...
src/lte/helper/lte-helper.h:850: * Number of CCs
that will be installed at eNodeB and UE devices

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/component-c...
File src/lte/model/component-carrier-enb.h (right):

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/component-c...
src/lte/model/component-carrier-enb.h:110: Ptr<LteEnbPhy> m_phy; ///< the Phy
the Phy instance of this eNodeB component carrier

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/component-c...
src/lte/model/component-carrier-enb.h:111: Ptr<LteEnbMac> m_mac; ///< the MAC
the MAC instance of this eNodeB component carrier

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/component-c...
src/lte/model/component-carrier-enb.h:112: Ptr<FfMacScheduler> m_scheduler; ///<
the scheduler
the scheduler instance of this eNodeB component carrier

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/component-c...
src/lte/model/component-carrier-enb.h:113: Ptr<LteFfrAlgorithm> m_ffrAlgorithm;
///< the FFR algorithm
the FFR algorithm instance of this eNodeB component carrier

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/component-c...
File src/lte/model/component-carrier-ue.h (right):

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/component-c...
src/lte/model/component-carrier-ue.h:83: Ptr<LteUePhy> m_phy; ///< the Phy
the Phy instance of this UE component carrier

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/component-c...
src/lte/model/component-carrier-ue.h:84: Ptr<LteUeMac> m_mac; ///< the MAC
the MAC instance of this UE component carrier

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/cqa-ff-mac-...
File src/lte/model/cqa-ff-mac-scheduler.cc (right):

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/cqa-ff-mac-...
src/lte/model/cqa-ff-mac-scheduler.cc:119: * CGA key comparator
CQA

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/epc-enb-app...
File src/lte/model/epc-enb-application.h (right):

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/epc-enb-app...
src/lte/model/epc-enb-application.h:136: uint8_t   m_bid; ///< Bid
the EPS Bearer IDentifier

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/epc-gtpu-he...
File src/lte/model/epc-gtpu-header.h (right):

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/epc-gtpu-he...
src/lte/model/epc-gtpu-header.h:101: * Get TEID function
Get a tunnel endpoint identificator (TEID)

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/epc-gtpu-he...
src/lte/model/epc-gtpu-header.h:116: * Set length function
Set the length in octets of the payload

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/epc-gtpu-he...
src/lte/model/epc-gtpu-header.h:129: void SetNPduNumber (uint8_t nPduNumber);
Sets the flag that indicates the presence of a meaningful value of the N-PDU
Number field

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/epc-mme.h
File src/lte/model/epc-mme.h (right):

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/epc-mme.h#n...
src/lte/model/epc-mme.h:91: * \param enbS1UAddr
address of the eNB for S1-U communications

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/epc-tft.cc
File src/lte/model/epc-tft.cc (right):

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/epc-tft.cc#...
src/lte/model/epc-tft.cc:34: * Output stream EPC TFT direction output operator
  34  * Output stream operator for EPC TFT direction

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/epc-tft.cc#...
src/lte/model/epc-tft.cc:59: * Output stream EPC TFT packet filter output
operator
Output stream for EPC TFT packet filter

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/epc-tft.h
File src/lte/model/epc-tft.h (right):

https://codereview.appspot.com/311650043/diff/30209/src/lte/model/epc-tft.h#n...
src/lte/model/epc-tft.h:157: uint8_t m_numFilters; ///< number of packt filters
number of packet filters applied to this TFT

[Biljana Bojović, 2017-06-02 13:37:28]

I reviewed, and agree with all changes, I just expanded on two placed word
"c-tor" to be "Contstructor" as in other places we use word Constructor. I
pushed it to changeset 12904 e949b994faad
http://code.nsnam.org/ns-3-dev/rev/e949b994faad.

Thanks, very good work,

Biljana