add modelines and some doxygen
authorTom Henderson <tomh@tomh.org>
Mon, 27 Apr 2015 17:57:44 -0700
changeset 11261 47f950fde9a7
parent 11260 42b48acf8fb7
child 11262 9666d77c8d1b
add modelines and some doxygen
src/stats/model/time-series-collector.cc
src/stats/model/time-series-collector.h
--- a/src/stats/model/time-series-collector.cc	Mon Apr 27 17:47:51 2015 -0700
+++ b/src/stats/model/time-series-collector.cc	Mon Apr 27 17:57:44 2015 -0700
@@ -1,3 +1,4 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
 /*
  * Copyright (c) 2015 Bucknell University
  *
@@ -51,7 +52,6 @@
 TimeSeriesCollector::TimeSeriesCollector ()
   : Collector (),
     m_hasReportBeenScheduled (false)
-
 {
   NS_LOG_FUNCTION (this);
 }
--- a/src/stats/model/time-series-collector.h	Mon Apr 27 17:47:51 2015 -0700
+++ b/src/stats/model/time-series-collector.h	Mon Apr 27 17:57:44 2015 -0700
@@ -1,3 +1,4 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
 /*
  * Copyright (c) 2015 Bucknell University
  *
@@ -60,7 +61,8 @@
   void TraceSinkDouble (double oldValue, double newValue);
 
   /**
-   * \brief Sets the time period to report data
+   * \brief Sets the time period to report data.  Cancels any pending
+   * report if one is scheduled.
    *
    * \param period a variable of type Time to indicate the period
    */
@@ -73,6 +75,13 @@
    */
   Time GetPeriod () const;
 
+  /**
+   * \brief Override DataCollectionObject::Enable() to schedule the very 
+   * first event whenever the collector is enabled.  This method will
+   * also cancel any previously scheduled event if one exists.
+   *  
+   * \sa ns3::DataCollectionObject::Enable
+   */
   void Enable (void);
 private:
   // the output data trace source