tcp: Doxygen improvements

src/internet/model/tcp-dctcp.h

@@ -29,8 +29,8 @@ namespace ns3 {
 /**
  * \ingroup tcp
  *
- * \brief An implementation of DCTCP. This model implements all the functionalities mentioned
- * in the DCTCP SIGCOMM paper except dynamic buffer allocation in switches
+ * \brief An implementation of DCTCP. This model implements all of the
+ * endpoint capabilities mentioned in the DCTCP SIGCOMM paper.
  */
 
 class TcpDctcp : public TcpNewReno
@@ -58,11 +58,7 @@ public:
    */
   virtual ~TcpDctcp (void);
 
-  /**
-   * \brief Get the name of the TCP flavour
-   *
-   * \return The name of the TCP
-   */
+  // Documented in base class
   virtual std::string GetName () const;
 
   /**
@@ -71,34 +67,15 @@ public:
    *        either ECT(0) or ECT(1) (depending on the 'UseEct0' attribute),
    *        despite any other configuration in the base classes.
    *
-   * \param ecnMode ECN Mode
+   * \param tcb internal congestion state
    */
   virtual void Init (Ptr<TcpSocketState> tcb);
 
+  // Documented in base class
   virtual Ptr<TcpCongestionOps> Fork ();
-
-  /**
-   * \brief Reduce congestion window based on DCTCP algorithm
-   *
-   * \param tcb internal congestion state
-   */
   virtual void ReduceCwnd (Ptr<TcpSocketState> tcb);
-
-  /**
-   * \brief Get information from the acked packet
-   *
-   * \param tcb internal congestion state
-   * \param segmentsAcked count of segments ACKed
-   * \param rtt The estimated rtt
-   */
   virtual void PktsAcked (Ptr<TcpSocketState> tcb, uint32_t segmentsAcked,
                           const Time &rtt);
-  /**
-   * \brief Trigger events/calculations on occurrence of congestion window event
-   *
-   * \param tcb internal state
-   * \param event congestion window event which triggered this function
-   */
   virtual void CwndEvent (Ptr<TcpSocketState> tcb,
                           const TcpSocketState::TcpCAEvent_t event);
 private:

src/internet/test/tcp-general-test.h

@@ -587,23 +587,23 @@ protected:
    * \brief Forcefully set the initial cwnd
    *
    * \param who socket to force
-   * \param initialCwnd size of the initial cwnd
+   * \param initialCwnd size of the initial cwnd (segments)
    */
   void SetInitialCwnd (SocketWho who, uint32_t initialCwnd);
 
   /**
-   * \brief Forcefully set the ecn use on
+   * \brief Forcefully set the ECN mode of use
    *
    * \param who socket to force
-   * \param useEcn Mode of ECN. Currently Off and On are supported.
+   * \param useEcn Value representing the mode of ECN usage requested
    */
   void SetUseEcn (SocketWho who, TcpSocketState::UseEcn_t useEcn);
 
   /**
-   * \brief Forcefully set the initial ssth
+   * \brief Forcefully set the initial ssthresh
    *
    * \param who socket to force
-   * \param initialSsThresh size of the initial ssth
+   * \param initialSsThresh Initial slow start threshold (bytes)
    */
   void SetInitialSsThresh (SocketWho who, uint32_t initialSsThresh);