From 8027faacca2dcfaec21ff0586f98a468af01f2fa Mon Sep 17 00:00:00 2001
From: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Date: Tue, 26 Aug 2008 11:17:31 -0700
Subject: [PATCH] doxygen OnOffHelper.

---
 src/helper/on-off-helper.h | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/src/helper/on-off-helper.h b/src/helper/on-off-helper.h
index a36ab49a5..3b4ac6cc1 100644
--- a/src/helper/on-off-helper.h
+++ b/src/helper/on-off-helper.h
@@ -31,13 +31,34 @@
 
 namespace ns3 {
 
+/**
+ * \brief instanciate an ns3::OnOffApplication on a set of nodes.
+ */
 class OnOffHelper
 {
 public:
+  /**
+   * \param protocol the name of the protocol to use to send traffic
+   *        by the applications. This string identifies the socket
+   *        factory type used to create sockets for the applications.
+   *        A typical value would be ns3::UdpSocketFactory.
+   * \param address the address of the remote node to send traffic
+   *        to.
+   */
   OnOffHelper (std::string protocol, Address address);
 
+  /**
+   * \param name the name of the application attribute to set
+   * \param value the value of the application attribute to set
+   */
   void SetAttribute (std::string name, const AttributeValue &value);
 
+  /**
+   * \param c the set of nodes on which an OnOffApplication will be installed.
+   *
+   * Install an ns3::OnOffApplication on each node of the input container
+   * configured with all the attributes set with SetAttribute.
+   */
   ApplicationContainer Install (NodeContainer c);
 
 private: