[gnome-break-timer] Documentation for CircleCounter.

[Dylan McCall <dylanmccall src gnome org>]

commit 9a5beec9d9b9c6bdb55436e36c0b97da0b5eeb5b
Author: Dylan McCall <dylanmccall ubuntu com>
Date:   Thu Sep 12 12:44:45 2013 -0700

    Documentation for CircleCounter.

 settings/CircleCounter.vala |   17 +++++++++++++++++
 1 files changed, 17 insertions(+), 0 deletions(-)
---
diff --git a/settings/CircleCounter.vala b/settings/CircleCounter.vala
index 4fb3963..cee813b 100644
--- a/settings/CircleCounter.vala
+++ b/settings/CircleCounter.vala
@@ -15,6 +15,13 @@
  * along with GNOME Break Timer.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+// TODO: Share code with gnome-clocks, instead of duplicating effort
+
+/**
+ * Displays a countdown using a circle, reminiscent of a countdown timer.
+ * This widget can either count down or up, and it can switch between either
+ * direction at any time.
+ */
 public class CircleCounter : Gtk.Widget {
        protected const double LINE_WIDTH = 5.0;
        protected const int DEFAULT_RADIUS = 48;
@@ -24,7 +31,17 @@ public class CircleCounter : Gtk.Widget {
                COUNT_UP
        }
 
+       /**
+        * The direction of the countdown.
+        * COUNT_DOWN: a full circle that disappears as progress increases
+        * COUNT_UP: a circle gradually appears as progress increases
+        */
        public Direction direction {get; set;}
+       /**
+        * A value from 0.0 to 1.0, where 1.0 means the count is finished. The
+        * circle will be filled by this amount according to the direction
+        * property.
+        */
        public double progress {get; set;}
 
        public CircleCounter () {