Cleaning up doxygen related changes
authorAshwin Narayan
Sat, 16 Jul 2011 13:57:50 -0400
changeset 7335a9fae1ab88e0
parent 7334 73cd7c02d5d3
child 7336 0ac15aa63508
Cleaning up doxygen related changes
src/wifi/model/monitor-wifi-mac.h
     1.1 --- a/src/wifi/model/monitor-wifi-mac.h	Sat Jul 16 13:52:11 2011 -0400
     1.2 +++ b/src/wifi/model/monitor-wifi-mac.h	Sat Jul 16 13:57:50 2011 -0400
     1.3 @@ -78,81 +78,31 @@
     1.4    virtual ~MonitorWifiMac ();
     1.5  
     1.6    /**
     1.7 -  * \param slotTime the slot duration
     1.8 -  */
     1.9 +   * The following functions have been inherited from RegularWifiMac.
    1.10 +   *
    1.11 +   */
    1.12 +
    1.13    void SetSlot (Time slotTime);
    1.14 -  /**
    1.15 -   * \param sifs the sifs duration
    1.16 -   */
    1.17    void SetSifs (Time sifs);
    1.18 -  /**
    1.19 -   * \param eifsNoDifs the duration of an EIFS minus DIFS.
    1.20 -   *
    1.21 -   * This value is used to calculate the EIFS depending
    1.22 -   * on AIFSN.
    1.23 -   */
    1.24    void SetEifsNoDifs (Time eifsNoDifs);
    1.25 -  /**
    1.26 -   * \param pifs the pifs duration.
    1.27 -   */
    1.28    void SetPifs (Time pifs);
    1.29 -  /**
    1.30 -   * \param ctsTimeout the duration of a CTS timeout.
    1.31 -   */
    1.32    void SetCtsTimeout (Time ctsTimeout);
    1.33 -  /**
    1.34 -   * \param ackTimeout the duration of an ACK timeout.
    1.35 -   */
    1.36    void SetAckTimeout (Time ackTimeout);
    1.37 -  /**
    1.38 -   * \returns the current PIFS duration.
    1.39 -   */
    1.40    Time GetPifs (void) const;
    1.41 -  /**
    1.42 -   * \returns the current SIFS duration.
    1.43 -   */ 
    1.44    Time GetSifs (void) const;
    1.45 -  /**
    1.46 -   * \returns the current slot duration.
    1.47 -   */ 
    1.48    Time GetSlot (void) const;
    1.49 -  /**
    1.50 -   * \returns the current EIFS minus DIFS duration
    1.51 -   */  
    1.52    Time GetEifsNoDifs (void) const;
    1.53 -  /**
    1.54 -   * \returns the current CTS timeout duration.
    1.55 -   */
    1.56    Time GetCtsTimeout (void) const;
    1.57 -  /**
    1.58 -   * \returns the current ACK timeout duration.
    1.59 -   */
    1.60    Time GetAckTimeout (void) const;
    1.61 -  /**
    1.62 -   * \returns the MAC address associated to this MAC layer.
    1.63 -   */
    1.64    virtual Mac48Address GetAddress (void) const;
    1.65 -  /**
    1.66 -   * Not applicable in Monitor Mode node
    1.67 -   */
    1.68 -  virtual Ssid GetSsid (void) const;
    1.69 -  /**
    1.70 -   * \param address the current address of this MAC layer.
    1.71 -   */
    1.72    virtual void SetAddress (Mac48Address address);
    1.73 -  /**
    1.74 -   * \brief Sets the interface in promiscuous mode.
    1.75 -   *
    1.76 -   * Enables promiscuous mode on the interface. Note that any further
    1.77 -   * filtering on the incoming frame path may affect the overall
    1.78 -   * behavior.
    1.79 -   */
    1.80    virtual void SetPromisc (void);
    1.81    
    1.82    /**
    1.83     * The following functions have been inherited from RegularMacWifi
    1.84 -   * but are not applicable in Monitor Mode
    1.85 +   * but are not applicable in Monitor Mode.
    1.86     */
    1.87 +  virtual Ssid GetSsid (void) const;
    1.88    virtual void SetSsid (Ssid ssid);
    1.89    virtual void SetBssid (Mac48Address bssid);
    1.90    virtual Mac48Address GetBssid (void) const;
    1.91 @@ -167,41 +117,13 @@
    1.92    void SetQosSupported (bool enable);
    1.93    bool GetQosSupported () const;
    1.94  
    1.95 -  /**
    1.96 -   * \param phy the physical layer attached to this MAC.
    1.97 -   */
    1.98    virtual void SetWifiPhy (Ptr<WifiPhy> phy);
    1.99 -  /**
   1.100 -   * \param stationManager the station manager attached to this MAC.
   1.101 -   */
   1.102    virtual void SetWifiRemoteStationManager (Ptr<WifiRemoteStationManager> stationManager);
   1.103  
   1.104 -  /**
   1.105 -   * This type defines the callback of a higher layer that a
   1.106 -   * WifiMac(-derived) object invokes to pass a packet up the stack.
   1.107 -   *
   1.108 -   * \param packet the packet that has been received.
   1.109 -   * \param from the MAC address of the device that sent the packet.
   1.110 -   * \param to the MAC address ot the device that the packet is
   1.111 -   * destined for.
   1.112 -   */
   1.113    typedef Callback<void, Ptr<Packet>, Mac48Address, Mac48Address> ForwardUpCallback;
   1.114 -  /**
   1.115 -   * \param upCallback the callback to invoke when a packet must be
   1.116 -   * forwarded up the stack.
   1.117 -   */
   1.118    virtual void SetForwardUpCallback (ForwardUpCallback upCallback);
   1.119 -  /**
   1.120 -   * \param linkUp the callback to invoke when the link becomes up.
   1.121 -   */
   1.122    virtual void SetLinkUpCallback (Callback<void> linkUp);
   1.123 -  /**
   1.124 -   * \param linkDown the callback to invoke when the link becomes down.
   1.125 -   */
   1.126    virtual void SetLinkDownCallback (Callback<void> linkDown);
   1.127 -  /* Next functions are not pure virtual so non Qos WifiMacs are not
   1.128 -   * forced to implement them.
   1.129 -   */ 
   1.130    virtual void SetBasicBlockAckTimeout (Time blockAckTimeout);
   1.131    virtual Time GetBasicBlockAckTimeout (void) const;
   1.132    virtual void SetCompressedBlockAckTimeout (Time blockAckTimeout);
   1.133 @@ -225,22 +147,8 @@
   1.134  
   1.135    Ssid m_ssid;
   1.136  
   1.137 -  /** This holds a pointer to the DCF instance for this WifiMac - used
   1.138 -  for transmission of frames to non-QoS peers. */
   1.139    Ptr<DcaTxop> m_dca;
   1.140  
   1.141 -  /**
   1.142 -   * \param standard the phy standard to be used
   1.143 -   *
   1.144 -   * This method is called by ns3::WifiMac::ConfigureStandard to
   1.145 -   * complete the configuration process for a requested phy standard.
   1.146 -   *
   1.147 -   * This method may be overriden by a derived class (e.g., in order
   1.148 -   * to apply DCF parameters specific to the usage model it is
   1.149 -   * dealing with), in which case the reimplementation may choose to
   1.150 -   * deal with certain values in the WifiPhyStandard enumeration, and
   1.151 -   * chain up to this implementation to deal with the remainder.
   1.152 -   */
   1.153    virtual void FinishConfigureStandard (enum WifiPhyStandard standard);
   1.154  
   1.155    /**