From ee75d43f6f19a295531323d22d035bc9fcabc289 Mon Sep 17 00:00:00 2001
From: Collin Guarino <collin.guarino@gmail.com>
Date: Sun, 14 Feb 2016 18:57:56 -0500
Subject: Added documentation for Bridge.GetSchedules and Schedule struct.

---
 schedule.go | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'schedule.go')

diff --git a/schedule.go b/schedule.go
index 43c7056..c7c2690 100644
--- a/schedule.go
+++ b/schedule.go
@@ -12,6 +12,7 @@ import (
     "encoding/json"
 )
 
+// Schedule struct defines attributes of Alarms and Timers
 type Schedule struct {
     Name        string   `json:"name"`
     Description string   `json:"description"`
@@ -30,6 +31,7 @@ type Schedule struct {
     ID          string
 }
 
+// Bridge.GetSchedules will get Alarms and Timers in a Schedule struct.
 func (bridge *Bridge) GetSchedules() ([]Schedule, error) {
     uri := fmt.Sprintf("/api/%s/schedules", bridge.Username)
     body, _, err := bridge.Get(uri)
-- 
cgit v1.2.3