F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

internet: further fixes to Doxygen description of callback signatures

Browse Source
This commit is contained in:
Tommaso Pecorella
2021-10-28 01:34:28 +02:00
parent f9ac0f0382
commit 4895deeefd
2 changed files with 25 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
src/internet/model/ipv4-l3-protocol.h
View File

@@ -225,9 +225,9 @@ public:
/**
* TracedCallback signature for packet send, forward, or local deliver events.
*
* \param [in] header The Ipv4Header.
* \param [in] packet The packet.
* \param [in] interface
* \param [in] header the Ipv4Header
* \param [in] packet the packet
* \param [in] interface IP-level interface number
*/
typedef void (* SentTracedCallback)
(const Ipv4Header & header, Ptr<const Packet> packet, uint32_t interface);
@@ -235,9 +235,9 @@ public:
/**
* TracedCallback signature for packet transmission or reception events.
*
* \param [in] packet The packet.
* \param [in] ipv4
* \param [in] interface
* \param [in] packet the packet.
* \param [in] ipv4 the Ipv4 protocol
* \param [in] interface IP-level interface number
* \deprecated The non-const \c Ptr<Ipv4> argument is deprecated
* and will be changed to \c Ptr<const Ipv4> in a future release.
*/
@@ -247,11 +247,11 @@ public:
/**
* TracedCallback signature for packet drop events.
*
* \param [in] header The Ipv4Header.
* \param [in] packet The packet.
* \param [in] reason The reason the packet was dropped.
* \param [in] ipv4
* \param [in] interface
* \param [in] header the Ipv4Header.
* \param [in] packet the packet.
* \param [in] reason the reason the packet was dropped.
* \param [in] ipv4 the Ipv4 protocol
* \param [in] interface IP-level interface number
* \deprecated The non-const \c Ptr<Ipv4> argument is deprecated
* and will be changed to \c Ptr<const Ipv4> in a future release.
*/
@@ -429,7 +429,7 @@ private:
* \param ipHeader the IP header that will be added to the packet
* \param packet the packet
* \param ipv4 the Ipv4 protocol
* \param interface the interface index
* \param interface the IP-level interface index
*
* Note: If the TracedCallback API ever is extended, we could consider
* to check for connected functions before adding the header

26
src/internet/model/ipv6-l3-protocol.h
View File

@@ -372,19 +372,19 @@ public:
* TracedCallback signature for packet sent, forwarded or
* local-delivered events.
*
* \param [in] header The Ipv6Header.
* \param [in] packet The packet.
* \param [in] interface
* \param [in] header the Ipv6Header.
* \param [in] packet the packet.
* \param [in] interface the IP-level interface index
*/
typedef void (* SentTracedCallback)
(const Ipv6Header & header, Ptr<const Packet> packet, uint32_t interface);
/**
* TracedCallback signature for packet transmission or reception events.
*
* \param [in] packet The packet.
* \param [in] ipv6
* \param [in] interface
* \param [in] packet the packet.
* \param [in] ipv6 the Ipv6 protocol
* \param [in] interface the IP-level interface index
* \deprecated The non-const \c Ptr<Ipv6> argument is deprecated
* and will be changed to \c Ptr<const Ipv6> in a future release.
*/
@@ -394,11 +394,11 @@ public:
/**
* TracedCallback signature for packet drop events.
*
* \param [in] header The Ipv6Header.
* \param [in] packet The packet.
* \param [in] reason The reason the packet was dropped.
* \param [in] ipv6
* \param [in] interface
* \param [in] header the Ipv6Header.
* \param [in] packet the packet.
* \param [in] reason the reason the packet was dropped.
* \param [in] ipv6 the Ipv6 protocol
* \param [in] interface the IP-level interface index
* \deprecated The non-const \c Ptr<Ipv6> argument is deprecated
* and will be changed to \c Ptr<const Ipv6> in a future release.
*/
@@ -532,7 +532,7 @@ private:
* \param ipHeader the IP header that will be added to the packet
* \param packet the packet
* \param ipv6 the Ipv6 protocol
* \param interface the interface index
* \param interface the IP-level interface index
*
* Note: If the TracedCallback API ever is extended, we could consider
* to check for connected functions before adding the header