Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(698)

Unified Diff: src/mesh/model/mesh-point-device.h

Issue 317150043: Final updates to correct doxygen warnings for the mesh module (Closed)
Patch Set: Additional doxygen updates Created 6 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « src/mesh/model/mesh-l2-routing-protocol.h ('k') | src/mesh/model/mesh-wifi-beacon.h » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: src/mesh/model/mesh-point-device.h
===================================================================
--- a/src/mesh/model/mesh-point-device.h
+++ b/src/mesh/model/mesh-point-device.h
@@ -49,7 +49,10 @@
class MeshPointDevice : public NetDevice
{
public:
- /// Object type ID for NS3 object system
+ /**
+ * \brief Get the type ID.
+ * \return the object TypeId
+ */
static TypeId GetTypeId ();
/// C-tor create empty (without interfaces and protocols) mesh point
MeshPointDevice ();
@@ -124,10 +127,27 @@
//\}
private:
- /// Receive packet from interface
+ /**
+ * Receive packet from interface
+ *
+ * \param device the device to receive from
+ * \param packet the received packet
+ * \param protocol the protocol
+ * \param source the source address
+ * \param destination the destination address
+ * \param packetType the packet type
+ */
void ReceiveFromDevice (Ptr<NetDevice> device, Ptr<const Packet> packet, uint16_t protocol,
Address const &source, Address const &destination, PacketType packetType);
- /// Forward packet down to interfaces
+ /**
+ * Forward packet down to interfaces
+ *
+ * \param incomingPort the incoming port
+ * \param packet the packet to forward
+ * \param protocol the protocol
+ * \param src the source MAC address
+ * \param dst the destination MAC address
+ */
void Forward (Ptr<NetDevice> incomingPort, Ptr<const Packet> packet,
uint16_t protocol, const Mac48Address src,
const Mac48Address dst);
« no previous file with comments | « src/mesh/model/mesh-l2-routing-protocol.h ('k') | src/mesh/model/mesh-wifi-beacon.h » ('j') | no next file with comments »

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b