add empty template for doxygen doc
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Thu, 29 Mar 2007 18:04:06 +0200
changeset 409 1cbb9ed862d0
parent 408 aaed1f423e07
child 410 d7beb754cfe9
add empty template for doxygen doc
src/devices/p2p/p2p-net-device.h
--- a/src/devices/p2p/p2p-net-device.h	Thu Mar 29 17:43:52 2007 +0200
+++ b/src/devices/p2p/p2p-net-device.h	Thu Mar 29 18:04:06 2007 +0200
@@ -36,6 +36,11 @@
 class Queue;
 class PointToPointChannel;
 
+/**
+ * \brief A duplex link
+ *
+ * XXX: Add small description of model implemented in this subclass of NetDevice.
+ */
 class PointToPointNetDevice : public NetDevice {
 public:
   enum TraceType {
@@ -50,6 +55,10 @@
 
   PointToPointNetDevice& operator= (PointToPointNetDevice nd);
 
+  /**
+   * \param bps the number of bits per second
+   *        which this interface can achieve.
+   */
   void SetDataRate(DataRate bps);
   void SetInterframeGap(Time t);