From eeb0d547f703daa6e106c7212a7e7bc79765a3e6 Mon Sep 17 00:00:00 2001
From: Bryant Mairs <bwmairs@gmail.com>
Date: Tue, 10 Jun 2014 14:38:52 -0700
Subject: [PATCH] Add documentation for setupPortList() now that I modified it.

---
 src/ui/SerialConfigurationWindow.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/ui/SerialConfigurationWindow.h b/src/ui/SerialConfigurationWindow.h
index ee4203186..57b8600ed 100644
--- a/src/ui/SerialConfigurationWindow.h
+++ b/src/ui/SerialConfigurationWindow.h
@@ -60,6 +60,12 @@ public slots:
     void setParityEven(bool accept);
     void setPortName(QString port);
     void setLinkName(QString name);
+    /**
+     * @brief setupPortList Populates the dropdown with the list of available serial ports.
+     * This function is called at 1s intervals to check that the serial port still exists and to see if
+     * any new ones have been attached.
+     * @return True if any ports were found, false otherwise.
+     */
     bool setupPortList();
 
 protected:
-- 
2.22.0