From 99c79ebf7eba40177e1f509e7af1229c5e2f6df9 Mon Sep 17 00:00:00 2001
From: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Date: Thu, 29 Mar 2007 17:43:52 +0200
Subject: [PATCH] doxygen for Ipv4L4Demux class

---
 src/node/ipv4-l4-demux.h | 42 ++++++++++++++++++++++++++++++++++++++--
 1 file changed, 40 insertions(+), 2 deletions(-)

diff --git a/src/node/ipv4-l4-demux.h b/src/node/ipv4-l4-demux.h
index d578366fb..5fad32e60 100644
--- a/src/node/ipv4-l4-demux.h
+++ b/src/node/ipv4-l4-demux.h
@@ -40,11 +40,49 @@ public:
   typedef int Ipv4L4ProtocolTraceType;
   Ipv4L4Demux (Node *node);
   virtual ~Ipv4L4Demux();
+
+  /**
+   * \param node the node on which the returned copy will run.
+   * \returns a deep copy of this L4 Demux.
+   */
   Ipv4L4Demux* Copy(Node *node) const;
+
+  /**
+   * \param context the trace context to use to construct the
+   *        TraceResolver to return
+   * \returns a TraceResolver which can resolve all traces
+   *          performed in this object. The caller must
+   *          delete the returned object.
+   */
   TraceResolver *CreateTraceResolver (TraceContext const &context);
-  Ipv4L4Protocol* Insert(const Ipv4L4Protocol&);
+  /**
+   * \param protocol a template for the protocol to add to this L4 Demux.
+   * \returns the L4Protocol effectively added.
+   *
+   * Invoke Copy on the input template to get a copy of the input
+   * protocol which can be used on the Node on which this L4 Demux 
+   * is running. The new L4Protocol is registered internally as
+   * a working L4 Protocol and returned from this method.
+   * The caller does not get ownership of the returned pointer.
+   */
+  Ipv4L4Protocol* Insert(const Ipv4L4Protocol&protocol);
+  /**
+   * \param protocolNumber number of protocol to lookup
+   *        in this L4 Demux
+   * \returns a matching L4 Protocol
+   *
+   * This method is typically called by lower layers
+   * to forward packets up the stack to the right protocol.
+   * It is also called from InternetNode::GetUdp for example.
+   */
   Ipv4L4Protocol* Lookup(int protocolNumber);
-  void        Erase(Ipv4L4Protocol*);
+  /**
+   * \param protocol protocol to remove from this demux.
+   *
+   * The input value to this method should be the value
+   * returned from the Ipv4L4Protocol::Insert method.
+   */
+  void Erase(Ipv4L4Protocol*protocol);
 private:
   typedef std::list<Ipv4L4Protocol*> L4List_t;
   L4List_t m_protocols;