From 6e60d167b70cfdb4d2ce39ddce9e15ec341cd3bf Mon Sep 17 00:00:00 2001
From: "Sean C. Rhea" <sean.c.rhea@gmail.com>
Date: Sat, 8 Mar 2008 16:26:12 +0000
Subject: [PATCH] added comments

---
 src/gui/RideFile.h | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/src/gui/RideFile.h b/src/gui/RideFile.h
index 3a866a3e1..d35ae83cc 100644
--- a/src/gui/RideFile.h
+++ b/src/gui/RideFile.h
@@ -25,6 +25,21 @@
 #include <QList>
 #include <QMap>
 
+// This file defines four classes:
+//
+// RideFile, as the name suggests, represents the data stored in a ride file,
+// regardless of what type of file it is (.raw, .srm, .csv).
+// 
+// RideFilePoint represents the data for a single sample in a RideFile.
+//
+// RideFileReader is an abstract base class for function-objects that take a
+// filename and return a RideFile object representing the ride stored in the
+// corresponding file.
+//
+// RideFileFactory is a singleton that maintains a mapping from ride file
+// suffixes to the RideFileReader objects capable of converting those files
+// into RideFile objects.
+
 struct RideFilePoint 
 {
     double secs, cad, hr, km, kph, nm, watts;