From 8dae50b840b8d2a61ca2259178291cb9c33bbf5f Mon Sep 17 00:00:00 2001
From: Matthew Kelly <mkelly2@iastate.edu>
Date: Wed, 4 Oct 2017 00:12:33 -0500
Subject: [PATCH] Added brief descriptions to frontend .h files

---
 groundStation/src/frontend/frontend_common.h  | 8 ++++++++
 groundStation/src/frontend/frontend_nodes.h   | 4 ++++
 groundStation/src/frontend/frontend_output.h  | 4 ++++
 groundStation/src/frontend/frontend_param.h   | 4 ++++
 groundStation/src/frontend/frontend_source.h  | 5 +++++
 groundStation/src/frontend/frontend_tracker.h | 5 +++++
 6 files changed, 30 insertions(+)

diff --git a/groundStation/src/frontend/frontend_common.h b/groundStation/src/frontend/frontend_common.h
index 2fef5c52a..827802875 100644
--- a/groundStation/src/frontend/frontend_common.h
+++ b/groundStation/src/frontend/frontend_common.h
@@ -1,3 +1,11 @@
+/**
+ * Frontend contains the functions used by both the GUI and CLI to communicate
+ * with the quad and VRPN system.
+ *
+ * frontend_common.c has the varius structs used within the frontend to pass
+ * data between the system. It also contains the methods to connect, disconnect,
+ * and write from/to the quad. 
+ */
 #ifndef _FRONTEND_COMMON_H
 #define _FRONTEND_COMMON_H
 #include <stdlib.h>
diff --git a/groundStation/src/frontend/frontend_nodes.h b/groundStation/src/frontend/frontend_nodes.h
index fa7d57f14..74bedc547 100644
--- a/groundStation/src/frontend/frontend_nodes.h
+++ b/groundStation/src/frontend/frontend_nodes.h
@@ -1,3 +1,7 @@
+/**
+ * frontend_nodes writes the getnodes or setnodes command to the backend connection.
+ */
+
 #ifndef _FRONTEND_NODES_H
 #define _FRONTEND_NODES_H
 
diff --git a/groundStation/src/frontend/frontend_output.h b/groundStation/src/frontend/frontend_output.h
index f0e2fbaea..8552abe63 100644
--- a/groundStation/src/frontend/frontend_output.h
+++ b/groundStation/src/frontend/frontend_output.h
@@ -1,3 +1,7 @@
+/**
+ * frontend_output writes the getoutput command to the backend connection.
+ */
+
 #ifndef _FRONTEND_OUTPUT_H
 #define _FRONTEND_OUTPUT_H
 
diff --git a/groundStation/src/frontend/frontend_param.h b/groundStation/src/frontend/frontend_param.h
index 392fbd83b..adf6ff061 100644
--- a/groundStation/src/frontend/frontend_param.h
+++ b/groundStation/src/frontend/frontend_param.h
@@ -1,3 +1,7 @@
+/**
+ * frontend_param writes the getparam or setparam command to the backend connection.
+ */
+
 #ifndef _FRONTEND_PARAM_H
 #define _FRONTEND_PARAM_H
 
diff --git a/groundStation/src/frontend/frontend_source.h b/groundStation/src/frontend/frontend_source.h
index 9488869ef..3de04fea6 100644
--- a/groundStation/src/frontend/frontend_source.h
+++ b/groundStation/src/frontend/frontend_source.h
@@ -1,3 +1,8 @@
+/**
+ * frontend_source writes the getsource and setsource command to the backend
+ * connection.
+ */
+
 #ifndef _FRONTEND_SOURCE_H
 #define _FRONTEND_SOURCE_H
 
diff --git a/groundStation/src/frontend/frontend_tracker.h b/groundStation/src/frontend/frontend_tracker.h
index cbf56dbb3..6a80a822f 100644
--- a/groundStation/src/frontend/frontend_tracker.h
+++ b/groundStation/src/frontend/frontend_tracker.h
@@ -1,3 +1,8 @@
+/**
+ * frontend_tracker contains the struct for VRPN data and provides the method to
+ * get the data from the frontend by writing TRACKERDATA to the backend.
+ */
+
 #ifndef __FRONTEND_TRACKER_H
 #define __FRONTEND_TRACKER_H
 
-- 
GitLab