From b48c5e0cc0e50d62d9b3842bac8fa533f1348c16 Mon Sep 17 00:00:00 2001
From: Joel Holdsworth <joel@joel-desktop.(none)>
Date: Sat, 24 Jan 2009 13:00:56 +0000
Subject: [PATCH] Added some ParentTrack documentation

---
 src/gui/model/parent-track.hpp | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/gui/model/parent-track.hpp b/src/gui/model/parent-track.hpp
index 5ef2c0265..bc26be80f 100644
--- a/src/gui/model/parent-track.hpp
+++ b/src/gui/model/parent-track.hpp
@@ -77,6 +77,13 @@ public:
    **/
   bool remove_descendant_track(const boost::shared_ptr<Track> track);
   
+  /**
+   * A utility function that attempts to find the parent of a track by
+   * searching through the tree from this track downward.
+   * @param child The child track to find the parent of.
+   * @return Returns the parent track if one was found, or an empty
+   * shared_ptr if none was found.
+   **/
   boost::shared_ptr<ParentTrack>
     find_descendant_track_parent(boost::shared_ptr<Track> child);