src/internet-node/udp-impl.h
changeset 2179 9b58bef0a7ff
parent 750 88b27f4950c8
child 2190 7f2b719b67fb
--- a/src/internet-node/udp-impl.h	Tue Dec 11 10:25:34 2007 +0100
+++ b/src/internet-node/udp-impl.h	Tue Dec 11 23:02:47 2007 -0800
@@ -28,12 +28,26 @@
 
 class UdpL4Protocol;
 
+/**
+ * \brief Object to create UDP socket instances 
+ *
+ * This class implements the API for UDP sockets.
+ * It is a socket factory (deriving from class SocketFactory) and can
+ * also hold global variables used to initialize newly created sockets, 
+ * such as values that are set through the sysctl or proc interfaces in Linux.
+ */
 class UdpImpl : public Udp
 {
 public:
   UdpImpl (Ptr<UdpL4Protocol> udp);
   virtual ~UdpImpl ();
 
+  /**
+   * \return smart pointer to Socket
+   * 
+   * Implements a method to create a UdpImpl-based socket and return
+   * a base class smart pointer to the socket.
+   */
   virtual Ptr<Socket> CreateSocket (void);
 
 protected: