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 6600 fb5ad9c7755a
parent 6599 e1a18247fa9c
child 6601 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
--- a/RELEASE_NOTES	Wed Aug 11 09:25:51 2010 -0400
+++ b/RELEASE_NOTES	Wed Aug 11 11:37:37 2010 -0400
@@ -83,6 +83,7 @@
    - bug 843 - Most wifi examples change BeaconInterval to unrealistic values
    - bug 844 - YansWifiPhy::GetPowerDbm off-by-one problem when calculating Tx 
                power
+   - bug 846 - packet.cc triggers deprecated warning
    - bug 853 - Rates for Wi-Fi control responses are incorrectly selected
    - bug 854 - Support DROP_QUEUE reason-code in Ipv4FlowProbe
    - bug 858 - support MSG_PEEK in IPv4/IPv6 raw socket
@@ -93,7 +94,7 @@
    - bug 873 - Queue occupancy counter not decremented in WifiMacQueue::Remove()
    - bug 874 - wrong modulation type is selected in the forwardBurst method
    - bug 875 - "frame includes FCS" flag should be set in Radiotap frame header
-   - bug 875 - Set FCS included flag in Radiotap header
+   - bug 879 - source address selection for AODV using DeferredRouteRequest
    - bug 881 - Reorganise to allow wider use of WifiInformationElement
    - bug 890 - several rate adaptation algorithms not tested by test.py
    - bug 900:  RawTextConfigLoad::Default does not load configurations
@@ -113,8 +114,11 @@
                wifi-remote-station-manager.h
    - bug 923 - Inconsistent declaration of class/struct in mac-low.h
    - bug 924 - Inconsistent declaration of class/struct in <xxx>-wifi-managers 
+   - bug 925 - Various IPv6 cc files trigger deprecated warning
    - bug 926 - olsr handling of multicast packets 
    - bug 927 - SimpleOfdmWimaxChannel RxPower computation
+   - bug 930 - examples/topology-read/topology-example-sim.cc uses variable 
+               length array
    - bug 931 - Abnormal exit reports SIGSEGV on failure
    - bug 932 - Support IP_HDRINCL option for Ipv4RawSocket
    - bug 933 - Flushing ostream and files on abnormal program exit 
@@ -131,7 +135,7 @@
                destination address to user callbacks 
    - bug 950 - PointToPointNetDevice says promisc support is not implemented 
                but it is
-   - bug 953 - WiMAX channel scanning overflow
+   - bug 955 - Install NSC for NS3 in a Itanium Architecture (ia64) with Linux 2.6.16.6
    - bug 956 - Bindings failure in core (traced-value) with older gcc
    - bug 958 - WiFi uses wrong default values for MTU, FragmentationThreshold 
                and RtsCtsThreshold
--- a/src/contrib/energy/model/basic-energy-source.h	Wed Aug 11 09:25:51 2010 -0400
+++ b/src/contrib/energy/model/basic-energy-source.h	Wed Aug 11 11:37:37 2010 -0400
@@ -68,14 +68,14 @@
   virtual double GetEnergyFraction (void);
 
   /**
-   * \param energy Amount of energy (in Joules) to decrease from energy source.
+   * \param energyJ Amount of energy (in Joules) to decrease from energy source.
    *
    * Implements DecreaseRemainingEnergy.
    */
   virtual void DecreaseRemainingEnergy (double energyJ);
 
   /**
-   * \param energy Amount of energy (in Joules) to increase from energy source.
+   * \param energyJ Amount of energy (in Joules) to increase from energy source.
    *
    * Implements IncreaseRemainingEnergy.
    */
@@ -87,7 +87,7 @@
   virtual void UpdateEnergySource (void);
 
   /**
-   * \param initialEnergy Initial energy, in Joules
+   * \param initialEnergyJ Initial energy, in Joules
    *
    * Sets initial energy stored in the energy source. Note that initial energy
    * is assumed to be set before simulation starts and is set only once per
@@ -96,7 +96,7 @@
   void SetInitialEnergy (double initialEnergyJ);
 
   /**
-   * \param supplyVoltage Supply voltage at the energy source, in Volts.
+   * \param supplyVoltageV Supply voltage at the energy source, in Volts.
    *
    * Sets supply voltage of the energy source.
    */
--- a/src/contrib/energy/model/energy-source.h	Wed Aug 11 09:25:51 2010 -0400
+++ b/src/contrib/energy/model/energy-source.h	Wed Aug 11 11:37:37 2010 -0400
@@ -97,7 +97,7 @@
   virtual double GetEnergyFraction (void) = 0;
 
   /**
-   * \param energy Amount of energy to decrease (in Joules)
+   * \param energyJ Amount of energy to decrease (in Joules)
    *
    * This function decreases the remaining energy in the energy source by the
    * specified amount. Provides linear interface for direct energy deduction.
@@ -105,7 +105,7 @@
   virtual void DecreaseRemainingEnergy (double energyJ) = 0;
 
   /**
-   * \param energy Amount of energy to increase (in Joules)
+   * \param energyJ Amount of energy to increase (in Joules)
    *
    * This function increases the remaining energy in the energy source by the
    * specified amount. Provides linear interface for direct energy increase.
@@ -136,7 +136,6 @@
 
   /**
    * \param deviceEnergyModelPtr Pointer to device energy model.
-   * \param tid TypeId of the specific device energy model.
    *
    * This function appends a device energy model to the end of a list of
    * DeviceEnergyModelInfo structs.