update release notes and fix doxygen warnings ns-3.9-RC1
authorJosh Pelkey <jpelkey@gatech.edu>
Wed, 11 Aug 2010 11:37:37 -0400
changeset 6553fb5ad9c7755a
parent 6552 e1a18247fa9c
child 6554 3d17e78189ec
update release notes and fix doxygen warnings
RELEASE_NOTES
src/contrib/energy/model/basic-energy-source.h
src/contrib/energy/model/energy-source.h
     1.1 --- a/RELEASE_NOTES	Wed Aug 11 09:25:51 2010 -0400
     1.2 +++ b/RELEASE_NOTES	Wed Aug 11 11:37:37 2010 -0400
     1.3 @@ -83,6 +83,7 @@
     1.4     - bug 843 - Most wifi examples change BeaconInterval to unrealistic values
     1.5     - bug 844 - YansWifiPhy::GetPowerDbm off-by-one problem when calculating Tx 
     1.6                 power
     1.7 +   - bug 846 - packet.cc triggers deprecated warning
     1.8     - bug 853 - Rates for Wi-Fi control responses are incorrectly selected
     1.9     - bug 854 - Support DROP_QUEUE reason-code in Ipv4FlowProbe
    1.10     - bug 858 - support MSG_PEEK in IPv4/IPv6 raw socket
    1.11 @@ -93,7 +94,7 @@
    1.12     - bug 873 - Queue occupancy counter not decremented in WifiMacQueue::Remove()
    1.13     - bug 874 - wrong modulation type is selected in the forwardBurst method
    1.14     - bug 875 - "frame includes FCS" flag should be set in Radiotap frame header
    1.15 -   - bug 875 - Set FCS included flag in Radiotap header
    1.16 +   - bug 879 - source address selection for AODV using DeferredRouteRequest
    1.17     - bug 881 - Reorganise to allow wider use of WifiInformationElement
    1.18     - bug 890 - several rate adaptation algorithms not tested by test.py
    1.19     - bug 900:  RawTextConfigLoad::Default does not load configurations
    1.20 @@ -113,8 +114,11 @@
    1.21                 wifi-remote-station-manager.h
    1.22     - bug 923 - Inconsistent declaration of class/struct in mac-low.h
    1.23     - bug 924 - Inconsistent declaration of class/struct in <xxx>-wifi-managers 
    1.24 +   - bug 925 - Various IPv6 cc files trigger deprecated warning
    1.25     - bug 926 - olsr handling of multicast packets 
    1.26     - bug 927 - SimpleOfdmWimaxChannel RxPower computation
    1.27 +   - bug 930 - examples/topology-read/topology-example-sim.cc uses variable 
    1.28 +               length array
    1.29     - bug 931 - Abnormal exit reports SIGSEGV on failure
    1.30     - bug 932 - Support IP_HDRINCL option for Ipv4RawSocket
    1.31     - bug 933 - Flushing ostream and files on abnormal program exit 
    1.32 @@ -131,7 +135,7 @@
    1.33                 destination address to user callbacks 
    1.34     - bug 950 - PointToPointNetDevice says promisc support is not implemented 
    1.35                 but it is
    1.36 -   - bug 953 - WiMAX channel scanning overflow
    1.37 +   - bug 955 - Install NSC for NS3 in a Itanium Architecture (ia64) with Linux 2.6.16.6
    1.38     - bug 956 - Bindings failure in core (traced-value) with older gcc
    1.39     - bug 958 - WiFi uses wrong default values for MTU, FragmentationThreshold 
    1.40                 and RtsCtsThreshold
     2.1 --- a/src/contrib/energy/model/basic-energy-source.h	Wed Aug 11 09:25:51 2010 -0400
     2.2 +++ b/src/contrib/energy/model/basic-energy-source.h	Wed Aug 11 11:37:37 2010 -0400
     2.3 @@ -68,14 +68,14 @@
     2.4    virtual double GetEnergyFraction (void);
     2.5  
     2.6    /**
     2.7 -   * \param energy Amount of energy (in Joules) to decrease from energy source.
     2.8 +   * \param energyJ Amount of energy (in Joules) to decrease from energy source.
     2.9     *
    2.10     * Implements DecreaseRemainingEnergy.
    2.11     */
    2.12    virtual void DecreaseRemainingEnergy (double energyJ);
    2.13  
    2.14    /**
    2.15 -   * \param energy Amount of energy (in Joules) to increase from energy source.
    2.16 +   * \param energyJ Amount of energy (in Joules) to increase from energy source.
    2.17     *
    2.18     * Implements IncreaseRemainingEnergy.
    2.19     */
    2.20 @@ -87,7 +87,7 @@
    2.21    virtual void UpdateEnergySource (void);
    2.22  
    2.23    /**
    2.24 -   * \param initialEnergy Initial energy, in Joules
    2.25 +   * \param initialEnergyJ Initial energy, in Joules
    2.26     *
    2.27     * Sets initial energy stored in the energy source. Note that initial energy
    2.28     * is assumed to be set before simulation starts and is set only once per
    2.29 @@ -96,7 +96,7 @@
    2.30    void SetInitialEnergy (double initialEnergyJ);
    2.31  
    2.32    /**
    2.33 -   * \param supplyVoltage Supply voltage at the energy source, in Volts.
    2.34 +   * \param supplyVoltageV Supply voltage at the energy source, in Volts.
    2.35     *
    2.36     * Sets supply voltage of the energy source.
    2.37     */
     3.1 --- a/src/contrib/energy/model/energy-source.h	Wed Aug 11 09:25:51 2010 -0400
     3.2 +++ b/src/contrib/energy/model/energy-source.h	Wed Aug 11 11:37:37 2010 -0400
     3.3 @@ -97,7 +97,7 @@
     3.4    virtual double GetEnergyFraction (void) = 0;
     3.5  
     3.6    /**
     3.7 -   * \param energy Amount of energy to decrease (in Joules)
     3.8 +   * \param energyJ Amount of energy to decrease (in Joules)
     3.9     *
    3.10     * This function decreases the remaining energy in the energy source by the
    3.11     * specified amount. Provides linear interface for direct energy deduction.
    3.12 @@ -105,7 +105,7 @@
    3.13    virtual void DecreaseRemainingEnergy (double energyJ) = 0;
    3.14  
    3.15    /**
    3.16 -   * \param energy Amount of energy to increase (in Joules)
    3.17 +   * \param energyJ Amount of energy to increase (in Joules)
    3.18     *
    3.19     * This function increases the remaining energy in the energy source by the
    3.20     * specified amount. Provides linear interface for direct energy increase.
    3.21 @@ -136,7 +136,6 @@
    3.22  
    3.23    /**
    3.24     * \param deviceEnergyModelPtr Pointer to device energy model.
    3.25 -   * \param tid TypeId of the specific device energy model.
    3.26     *
    3.27     * This function appends a device energy model to the end of a list of
    3.28     * DeviceEnergyModelInfo structs.