From ef17ad80723ac934b95cfa9975c674c0b1617d1e Mon Sep 17 00:00:00 2001
From: Sachith Hasaranga Seneviratne <sachith500@gmail.com>
Date: Tue, 5 Aug 2014 20:28:40 +0530
Subject: [PATCH] Added comments to TrackObjectManager

---
 src/tracks/track_object_manager.cpp | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/src/tracks/track_object_manager.cpp b/src/tracks/track_object_manager.cpp
index cb511f934..694b0b718 100644
--- a/src/tracks/track_object_manager.cpp
+++ b/src/tracks/track_object_manager.cpp
@@ -88,6 +88,9 @@ void TrackObjectManager::reset()
 }   // reset
 
 // ----------------------------------------------------------------------------
+/** disables all track objects with a particular ID
+ *  \param name Name or ID for disabling
+ */
 void TrackObjectManager::disable(std::string name)
 {
      TrackObject* curr;
@@ -105,6 +108,10 @@ void TrackObjectManager::disable(std::string name)
             }
      }
 }
+// ----------------------------------------------------------------------------
+/** enables all track objects with a particular ID
+ *  \param name Name or ID for enabling
+ */
 void TrackObjectManager::enable(std::string name)
 {
      TrackObject* curr;
@@ -124,6 +131,11 @@ void TrackObjectManager::enable(std::string name)
             }
      }
 }
+// ----------------------------------------------------------------------------
+/**  returns activation status for all track objects
+ *   with a particular ID
+ *   \param name Name or ID of track object
+ */
 bool TrackObjectManager::getStatus(std::string name)
 {
      TrackObject* curr;
@@ -138,7 +150,11 @@ bool TrackObjectManager::getStatus(std::string name)
      //object not found
      return false;
 }
-
+// ----------------------------------------------------------------------------
+/** returns a reference to the track object
+ *  with a particular ID
+ *  \param name Name or ID of track object
+ */
 TrackObject* TrackObjectManager::getTrackObject(std::string name)
 {
     TrackObject* curr;