From 3622356bab97a802cf3a5fd4e072372053f59cf3 Mon Sep 17 00:00:00 2001 From: Tom Henderson Date: Sat, 20 Aug 2016 13:57:42 +0200 Subject: [PATCH] Doxygen: fix various glithces --- src/internet/model/tcp-htcp.h | 22 ++++-------- src/internet/model/tcp-yeah.h | 2 +- src/network/utils/dynamic-queue-limits.h | 7 ++++ src/network/utils/radiotap-header.h | 46 ++++++++++++++++++------ 4 files changed, 49 insertions(+), 28 deletions(-) diff --git a/src/internet/model/tcp-htcp.h b/src/internet/model/tcp-htcp.h index e2a997e26..06d3398d3 100644 --- a/src/internet/model/tcp-htcp.h +++ b/src/internet/model/tcp-htcp.h @@ -79,33 +79,23 @@ protected: private: /** - * \brief calculates alpha as an increment parameter for HTCP - * - * \param tcb as TcpSocketState - * - * \return updated value of alpha as the increment factor + * \brief Updates the additive increase parameter for H-TCP */ void UpdateAlpha (void); /** - * \brief calculates beta as the decrement parameter for HTCP - * - * \param tcb as TcpSocketState - * - * \return updated value of beta as the decrement factor + * \brief Updates the multiplicative decrease factor beta for H-TCP */ void UpdateBeta (void); - // h-tcp varaibles - double m_alpha; //!< Adjusting the AMID increase parameter by - //f_alpha(m_delta) function - double m_beta; //!< AMID decrease parameter + // h-tcp variables + double m_alpha; //!< AMID additive increase parameter + double m_beta; //!< AMID multiplicative decrease factor double m_defaultBackoff; //!< default value when throughput ratio less than default double m_throughputRatio; //!< ratio of two consequence throughput Time m_delta; //!< Time in second that has elapsed since the //last congestion event experienced by a flow - Time m_deltaL; //!< Threshold for switching between standard - //and new increase function + Time m_deltaL; //!< Threshold for switching between standard and new increase function Time m_lastCon; //!< Time of the last congestion for the flow Time m_minRtt; //!< Minimum RTT in each congestion period Time m_maxRtt; //!< Maximum RTT in each congestion period diff --git a/src/internet/model/tcp-yeah.h b/src/internet/model/tcp-yeah.h index 8beac0cf8..e1315c487 100644 --- a/src/internet/model/tcp-yeah.h +++ b/src/internet/model/tcp-yeah.h @@ -103,7 +103,7 @@ public: * propagation delay (baseRtt). * * \param tcb internal congestion state - * \param segementsAcked count of segments ACKed + * \param segmentsAcked count of segments ACKed * \param rtt last RTT * */ diff --git a/src/network/utils/dynamic-queue-limits.h b/src/network/utils/dynamic-queue-limits.h index aaff3edaa..442aced4b 100644 --- a/src/network/utils/dynamic-queue-limits.h +++ b/src/network/utils/dynamic-queue-limits.h @@ -77,6 +77,13 @@ public: virtual void Queued (uint32_t count); private: + /** + * Calculates the difference between the two operators and + * returns the number if positive, zero otherwise. + * \param a First operator. + * \param b Second operator. + * \returns the difference between a and b if positive, zero otherwise. + */ int32_t Posdiff (int32_t a, int32_t b); // Fields accessed in enqueue path diff --git a/src/network/utils/radiotap-header.h b/src/network/utils/radiotap-header.h index bdaf3244d..b6c67e042 100644 --- a/src/network/utils/radiotap-header.h +++ b/src/network/utils/radiotap-header.h @@ -40,8 +40,8 @@ class RadiotapHeader : public Header public: RadiotapHeader (); /** - * \brief Get the type ID. - * \return the object TypeId + * @brief Get the type ID. + * @returns the object TypeId */ static TypeId GetTypeId (void); virtual TypeId GetInstanceTypeId (void) const; @@ -111,7 +111,10 @@ public: */ uint64_t GetTsft (void) const; - enum + /** + * @brief Frame flags. + */ + enum FrameFlag { FRAME_FLAG_NONE = 0x00, /**< No flags set */ FRAME_FLAG_CFP = 0x01, /**< Frame sent/received during CFP */ @@ -149,7 +152,10 @@ public: */ uint8_t GetRate (void) const; - enum + /** + * @brief Channel flags. + */ + enum ChannelFlags { CHANNEL_FLAG_NONE = 0x0000, /**< No flags set */ CHANNEL_FLAG_TURBO = 0x0010, /**< Turbo Channel */ @@ -219,7 +225,10 @@ public: */ uint8_t GetAntennaNoisePower (void) const; - enum + /** + * @brief MCS known bits. + */ + enum McsKnown { MCS_KNOWN_NONE = 0x00, /**< No flags set */ MCS_KNOWN_BANDWIDTH = 0x01, /**< Bandwidth */ @@ -232,7 +241,10 @@ public: MCS_KNOWN_NESS_BIT_1 = 0x80, /**< Ness data - bit 1 (MSB) of Number of extension spatial streams */ }; - enum + /** + * @brief MCS flags. + */ + enum McsFlags { MCS_FLAGS_NONE = 0x00, /**< Default: 20 MHz, long guard interval, mixed HT format and BCC FEC type */ MCS_FLAGS_BANDWIDTH_40 = 0x01, /**< 40 MHz */ @@ -273,7 +285,10 @@ public: */ uint8_t GetMcsRate (void) const; - enum + /** + * @brief A-MPDU status flags. + */ + enum AmpduFlags { A_MPDU_STATUS_NONE = 0x00, /**< No flags set */ A_MPDU_STATUS_REPORT_ZERO_LENGTH = 0x01, /**< Driver reports 0-length subframes */ @@ -306,7 +321,10 @@ public: */ uint16_t GetAmpduStatusFlags (void) const; - enum + /** + * @brief VHT known bits. + */ + enum VhtKnown { VHT_KNOWN_NONE = 0x0000, /**< No flags set */ VHT_KNOWN_STBC = 0x0001, /**< Space-time block coding (1 if all spatial streams of all users have STBC, 0 otherwise). */ @@ -320,14 +338,17 @@ public: VHT_KNOWN_PARTIAL_AID = 0x0100, /**< Partial AID known/applicable */ }; - enum + /** + * @brief VHT flags. + */ + enum VhtFlags { VHT_FLAGS_NONE = 0x00, /**< No flags set */ VHT_FLAGS_STBC = 0x01, /**< Set if all spatial streams of all users have space-time block coding */ VHT_FLAGS_TXOP_PS_NOT_ALLOWED = 0x02, /**< Set if STAs may not doze during TXOP (valid only for AP transmitters). */ VHT_FLAGS_GUARD_INTERVAL = 0x04, /**< Short guard interval */ VHT_FLAGS_SHORT_GI_NSYM_DISAMBIGUATION = 0x08, /**< Set if NSYM mod 10 = 9 (valid only if short GI is used).*/ - VHT_FLAGS__LDPC_EXTRA_OFDM_SYMBOL = 0x10, /**< Set if one or more users are using LDPC and the encoding process resulted in extra OFDM symbol(s) */ + VHT_FLAGS_LDPC_EXTRA_OFDM_SYMBOL = 0x10, /**< Set if one or more users are using LDPC and the encoding process resulted in extra OFDM symbol(s) */ VHT_FLAGS_BEAMFORMED = 0x20, /**< Set if beamforming is used (valid for SU PPDUs only). */ }; @@ -410,7 +431,10 @@ public: private: - enum + /** + * @brief Radiotap flags. + */ + enum RadiotapFlags { RADIOTAP_TSFT = 0x00000001, RADIOTAP_FLAGS = 0x00000002,