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

Fix Doxygen comment formatting and typos

Browse Source
This commit is contained in:
Eduardo Almeida
2022-10-16 14:49:21 +01:00
parent 33ff238ccb
commit 85ade4e18d
122 changed files with 1112 additions and 878 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
src/sixlowpan/model/sixlowpan-net-device.h
View File

@@ -201,7 +201,8 @@ class SixLowPanNetDevice : public NetDevice
* \param [in] contextId context id (most be between 0 and 15 included).
* \param [in] contextPrefix context prefix to be used in compression/decompression.
* \param [in] compressionAllowed compression and decompression allowed (true), decompression
* only (false). \param [in] validLifetime validity time (relative to the actual time).
* only (false).
* \param [in] validLifetime validity time (relative to the actual time).
*
*/
void AddContext(uint8_t contextId,
@@ -215,7 +216,8 @@ class SixLowPanNetDevice : public NetDevice
* \param [in] contextId context id (most be between 0 and 15 included).
* \param [out] contextPrefix context prefix to be used in compression/decompression.
* \param [out] compressionAllowed compression and decompression allowed (true), decompression
* only (false). \param [out] validLifetime validity time (relative to the actual time).
* only (false).
* \param [out] validLifetime validity time (relative to the actual time).
*
* \return false if the context has not been found.
*
@@ -274,10 +276,11 @@ class SixLowPanNetDevice : public NetDevice
/**
* \param [in] packet Packet sent from above down to Network Device.
* \param [in] source Source mac address (only used if doSendFrom is true, i.e., "MAC
* spoofing"). \param [in] dest Mac address of the destination (already resolved). \param [in]
* protocolNumber Identifies the type of payload contained in this packet. Used to call the
* right L3Protocol when the packet is received. \param [in] doSendFrom Perform a SendFrom
* instead of a Send.
* spoofing").
* \param [in] dest Mac address of the destination (already resolved).
* \param [in] protocolNumber Identifies the type of payload contained in this packet. Used to
* call the right L3Protocol when the packet is received.
* \param [in] doSendFrom Perform a SendFrom instead of a Send.
*
* Called from higher layer to send packet into Network Device
* with the specified source and destination Addresses.
@@ -546,11 +549,14 @@ class SixLowPanNetDevice : public NetDevice
/**
* \brief Performs a packet fragmentation.
* \param [in] packet the packet to be fragmented (with headers already compressed with
* 6LoWPAN). \param [in] origPacketSize the size of the IP packet before the 6LoWPAN header
* compression, including the IP/L4 headers. \param [in] origHdrSize the size of the IP header
* before the 6LoWPAN header compression. \param [in] extraHdrSize the sum of the sizes of BC0
* header and MESH header if mesh routing is used or 0. \param [out] listFragments A reference
* to the list of the resulting packets, all with the proper headers in place.
* 6LoWPAN).
* \param [in] origPacketSize the size of the IP packet before the 6LoWPAN header compression,
* including the IP/L4 headers.
* \param [in] origHdrSize the size of the IP header before the 6LoWPAN header compression.
* \param [in] extraHdrSize the sum of the sizes of BC0 header and MESH header if mesh routing
* is used or 0.
* \param [out] listFragments A reference to the list of the resulting packets, all with the
* proper headers in place.
*/
void DoFragmentation(Ptr<Packet> packet,
uint32_t origPacketSize,
@@ -613,8 +619,8 @@ class SixLowPanNetDevice : public NetDevice
uint16_t m_meshCacheLength; //!< length of the cache for each source.
Ptr<RandomVariableStream>
m_meshUnderJitter; //!< Random variable for the mesh-under packet retransmission.
std::map<Address /* OriginatorAdddress */, std::list<uint8_t /* SequenceNumber */>>
m_seenPkts; //!< Seen packets, memorized by OriginatorAdddress, SequenceNumber.
std::map<Address /* OriginatorAddress */, std::list<uint8_t /* SequenceNumber */>>
m_seenPkts; //!< Seen packets, memorized by OriginatorAddress, SequenceNumber.
Ptr<Node> m_node; //!< Smart pointer to the Node.
Ptr<NetDevice> m_netDevice; //!< Smart pointer to the underlying NetDevice.
@@ -670,7 +676,7 @@ class SixLowPanNetDevice : public NetDevice
* \brief Clean an address from its prefix.
*
* This function is used to find the relevant bits to be sent in stateful IPHC compression.
* Only the pefix length is used - the address prefix is assumed to be matching the prefix.
* Only the prefix length is used - the address prefix is assumed to be matching the prefix.
*
* \param address the address to be cleaned
* \param prefix the prefix to remove