1.1 --- a/src/applications/v4ping/v4ping.h	Thu Oct 01 10:21:12 2009 +0200
     1.2 +++ b/src/applications/v4ping/v4ping.h	Thu Oct 01 11:16:04 2009 +0200
     1.3 @@ -9,11 +9,20 @@
     1.4  
     1.5  class Socket;
     1.6  
     1.7 +/**
     1.8 + * \brief an application which sends one ICMP ECHO request, waits for a REPLYs
     1.9 + *        and reports the calculated RTT.
    1.10 + *
    1.11 + * Note: The RTT calculated is reported through a trace source.
    1.12 + */
    1.13  class V4Ping : public Application
    1.14  {
    1.15  public:
    1.16    static TypeId GetTypeId (void);
    1.17  
    1.18 +  /**
    1.19 +   * create a pinger applications
    1.20 +   */
    1.21    V4Ping ();
    1.22    virtual ~V4Ping ();
    1.23  

     2.1 --- a/src/helper/v4ping-helper.cc	Thu Oct 01 10:21:12 2009 +0200
     2.2 +++ b/src/helper/v4ping-helper.cc	Thu Oct 01 11:16:04 2009 +0200
     2.3 @@ -30,12 +30,6 @@
     2.4    m_factory.Set ("Remote", Ipv4AddressValue (remote));
     2.5  }
     2.6  
     2.7 -void 
     2.8 -V4PingHelper::SetAttribute (std::string name, const AttributeValue &value)
     2.9 -{
    2.10 -  m_factory.Set (name, value);
    2.11 -}
    2.12 -
    2.13  ApplicationContainer
    2.14  V4PingHelper::Install (Ptr<Node> node) const
    2.15  {

     3.1 --- a/src/helper/v4ping-helper.h	Thu Oct 01 10:21:12 2009 +0200
     3.2 +++ b/src/helper/v4ping-helper.h	Thu Oct 01 11:16:04 2009 +0200
     3.3 @@ -7,15 +7,40 @@
     3.4  
     3.5  namespace ns3 {
     3.6  
     3.7 +/**
     3.8 + * \brief create a pinger application and associate it to a node
     3.9 + *
    3.10 + * This class creates one or multiple instances of ns3::V4Ping and associates
    3.11 + * it/them to one/multiple node(s).
    3.12 + */
    3.13  class V4PingHelper
    3.14  {
    3.15  public:
    3.16 +  /**
    3.17 +   * \param remote the address which should be pinged
    3.18 +   */
    3.19    V4PingHelper (Ipv4Address remote);
    3.20  
    3.21 -  void SetAttribute (std::string name, const AttributeValue &value);
    3.22 -
    3.23 +  /**
    3.24 +   * \param nodes the list of nodes.
    3.25 +   *
    3.26 +   * Install a pinger application on each node in the input list of nodes.
    3.27 +   * \returns a list of pinger applications, one for each input node
    3.28 +   */
    3.29    ApplicationContainer Install (NodeContainer nodes) const;
    3.30 +  /**
    3.31 +   * \param node the node
    3.32 +   *
    3.33 +   * Install a pinger application on the input node
    3.34 +   * \returns the pinger application created.
    3.35 +   */
    3.36    ApplicationContainer Install (Ptr<Node> node) const;
    3.37 +  /**
    3.38 +   * \param nodeName the node
    3.39 +   *
    3.40 +   * Install a pinger application on the input node
    3.41 +   * \returns the pinger application created.
    3.42 +   */
    3.43    ApplicationContainer Install (std::string nodeName) const;
    3.44  
    3.45  private: