From cbafcb5aa63c07158b56fbe49cdabc22587182b0 Mon Sep 17 00:00:00 2001
From: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Date: Tue, 11 Dec 2007 17:53:54 +0100
Subject: [PATCH] updated doxygen

---
 src/contrib/delay-jitter-estimation.h | 31 +++++++++++++++++++++++++++
 src/contrib/wscript                   |  2 ++
 2 files changed, 33 insertions(+)

diff --git a/src/contrib/delay-jitter-estimation.h b/src/contrib/delay-jitter-estimation.h
index d4dc0e5bf..d8358fd20 100644
--- a/src/contrib/delay-jitter-estimation.h
+++ b/src/contrib/delay-jitter-estimation.h
@@ -6,14 +6,45 @@
 
 namespace ns3 {
 
+/**
+ * \brief quick and diry delay and jitter estimation
+ *
+ */
 class DelayJitterEstimation
 {
 public:
   DelayJitterEstimation ();
+
+  /**
+   * \param packet the packet to send over a wire
+   *
+   * This method should be invoked once on each packet to
+   * record within the packet the tx time which is used upon
+   * packet reception to calculate the delay and jitter. The
+   * tx time is stored in the packet as an ns3::Tag which means
+   * that it does not use any network ressources and is not
+   * taken into account in transmission delay calculations.
+   */
   static void PrepareTx (Ptr<const Packet> packet);
+  /**
+   * \param packet the packet received
+   *
+   * Invoke this method to update the delay and jitter calculations
+   * After a call to this method, \ref GetLastDelay and \ref GetLastJitter
+   * will return an updated delay and jitter.
+   */
   void RecordRx (Ptr<const Packet> packet);
 
+  /**
+   * \returns the updated delay.
+   */
   Time GetLastDelay (void) const;
+  /**
+   * The jitter is calculated using the RFC 1889 (RTP) jitter
+   * definition.
+   *
+   * \returns the updated jitter.
+   */
   Time GetLastJitter (void) const;
 
 private:
diff --git a/src/contrib/wscript b/src/contrib/wscript
index 2e89aac37..bbcc87009 100644
--- a/src/contrib/wscript
+++ b/src/contrib/wscript
@@ -5,10 +5,12 @@ def build(bld):
     module.source = [
         'event-garbage-collector.cc',
         'gnuplot.cc',
+        'delay-jitter-estimation.cc',
         ]
 
     headers = bld.create_obj('ns3header')
     headers.source = [
         'event-garbage-collector.h',
         'gnuplot.h',
+        'delay-jitter-estimation.h',
         ]