[Doxygen] use \deprecated

This commit is contained in:
Peter D. Barnes, Jr.
2013-06-11 17:27:05 -07:00
parent 1bca805862
commit 433a24d419
8 changed files with 11 additions and 3 deletions

View File

@@ -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.

View File

@@ -885,6 +885,7 @@ protected:
void SetDataDir (std::string directory);
/**
* \deprecated
* This method is deprecated. IsStatusFailure replaces it.
*/
bool GetErrorStatus (void) const NS_DEPRECATED;

View File

@@ -110,6 +110,7 @@ public:
*
* \param network The IPv6 network
* \param prefix The prefix
* \deprecated
*/
void NewNetwork (Ipv6Address network, Ipv6Prefix prefix) NS_DEPRECATED;

View File

@@ -145,6 +145,7 @@ public:
/**
* \param oif outgoing interface
* \return TTL for this route
* \deprecated
*/
uint32_t GetOutputTtl (uint32_t oif) NS_DEPRECATED;

View File

@@ -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;

View File

@@ -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

View File

@@ -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);

View File

@@ -45,9 +45,9 @@ enum WifiPhyStandard
* ACM MOBICOM, 2001.
*/
WIFI_PHY_STANDARD_holland,
/** deprecated, see <A HREF="http://www.nsnam.org/bugzilla/show_bug.cgi?id=945">bug 945</A> */
/** \deprecated see <A HREF="http://www.nsnam.org/bugzilla/show_bug.cgi?id=945">bug 945</A> */
WIFI_PHY_STANDARD_80211p_CCH,
/** deprecated, see <A HREF="http://www.nsnam.org/bugzilla/show_bug.cgi?id=945">bug 945</A> */
/** \deprecated see <A HREF="http://www.nsnam.org/bugzilla/show_bug.cgi?id=945">bug 945</A> */
WIFI_PHY_STANDARD_80211p_SCH
};