From 433a24d4195cffe505e3880dc2341a8d6684fbe5 Mon Sep 17 00:00:00 2001 From: "Peter D. Barnes, Jr." Date: Tue, 11 Jun 2013 17:27:05 -0700 Subject: [PATCH] [Doxygen] use \deprecated --- src/core/model/ref-count-base.h | 1 + src/core/model/test.h | 1 + src/internet/helper/ipv6-address-helper.h | 1 + src/internet/model/ipv4-route.h | 1 + src/internet/model/ipv6-route.h | 1 + src/network/model/packet.h | 2 ++ src/uan/model/uan-phy-dual.h | 3 ++- src/wifi/model/wifi-phy-standard.h | 4 ++-- 8 files changed, 11 insertions(+), 3 deletions(-) diff --git a/src/core/model/ref-count-base.h b/src/core/model/ref-count-base.h index ae4be6baf..a3d0b929e 100644 --- a/src/core/model/ref-count-base.h +++ b/src/core/model/ref-count-base.h @@ -30,6 +30,7 @@ namespace ns3 { /** * \brief A deprecated way to get reference-counting powers * + * \deprecated * Users who wish to use reference counting for a class of their own should use * instead the template \ref ns3::SimpleRefCount. This class is maintained * purely for compatibility to avoid breaking the code of users. diff --git a/src/core/model/test.h b/src/core/model/test.h index 889e754b1..e3229c472 100644 --- a/src/core/model/test.h +++ b/src/core/model/test.h @@ -885,6 +885,7 @@ protected: void SetDataDir (std::string directory); /** + * \deprecated * This method is deprecated. IsStatusFailure replaces it. */ bool GetErrorStatus (void) const NS_DEPRECATED; diff --git a/src/internet/helper/ipv6-address-helper.h b/src/internet/helper/ipv6-address-helper.h index 0c3f4c944..ebff40415 100644 --- a/src/internet/helper/ipv6-address-helper.h +++ b/src/internet/helper/ipv6-address-helper.h @@ -110,6 +110,7 @@ public: * * \param network The IPv6 network * \param prefix The prefix + * \deprecated */ void NewNetwork (Ipv6Address network, Ipv6Prefix prefix) NS_DEPRECATED; diff --git a/src/internet/model/ipv4-route.h b/src/internet/model/ipv4-route.h index 5fb44d42e..3c5dc2be0 100644 --- a/src/internet/model/ipv4-route.h +++ b/src/internet/model/ipv4-route.h @@ -145,6 +145,7 @@ public: /** * \param oif outgoing interface * \return TTL for this route + * \deprecated */ uint32_t GetOutputTtl (uint32_t oif) NS_DEPRECATED; diff --git a/src/internet/model/ipv6-route.h b/src/internet/model/ipv6-route.h index 855ca97f1..d1e674787 100644 --- a/src/internet/model/ipv6-route.h +++ b/src/internet/model/ipv6-route.h @@ -200,6 +200,7 @@ public: * \brief Get output TTL for this route. * \param oif outgoing interface * \return TTL for this route + * \deprecated */ uint32_t GetOutputTtl (uint32_t oif) NS_DEPRECATED; diff --git a/src/network/model/packet.h b/src/network/model/packet.h index 954220de7..ce8b7b6cf 100644 --- a/src/network/model/packet.h +++ b/src/network/model/packet.h @@ -340,6 +340,8 @@ public: * * If you try to change the content of the buffer * returned by this method, you will die. + * + * \deprecated * Note that this method is now deprecated and will be removed in * a future version of ns-3. To get access to the content * of the byte buffer of a packet, call CopyData"()" to perform diff --git a/src/uan/model/uan-phy-dual.h b/src/uan/model/uan-phy-dual.h index 87f62e590..4be6b2349 100644 --- a/src/uan/model/uan-phy-dual.h +++ b/src/uan/model/uan-phy-dual.h @@ -95,7 +95,8 @@ public: virtual void SetReceiveErrorCallback (RxErrCallback cb); virtual void SetRxGainDb (double gain); virtual void SetTxPowerDb (double txpwr); - virtual void SetRxThresholdDb (double thresh); + /** \deprecated Look at PER Functor attribute */ + virtual void SetRxThresholdDb (double thresh) NS_DEPRECATED; virtual void SetCcaThresholdDb (double thresh); virtual double GetRxGainDb (void); virtual double GetTxPowerDb (void); diff --git a/src/wifi/model/wifi-phy-standard.h b/src/wifi/model/wifi-phy-standard.h index 99a60de2f..3e203f68e 100644 --- a/src/wifi/model/wifi-phy-standard.h +++ b/src/wifi/model/wifi-phy-standard.h @@ -45,9 +45,9 @@ enum WifiPhyStandard * ACM MOBICOM, 2001. */ WIFI_PHY_STANDARD_holland, - /** deprecated, see bug 945 */ + /** \deprecated see bug 945 */ WIFI_PHY_STANDARD_80211p_CCH, - /** deprecated, see bug 945 */ + /** \deprecated see bug 945 */ WIFI_PHY_STANDARD_80211p_SCH };