diff --git a/groundStation/src/frontend/frontend_common.h b/groundStation/src/frontend/frontend_common.h index 2fef5c52ae8978e70b153f0579b063d62d979fe4..827802875d089908631568fa4d1b713e39569c44 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 fa7d57f14c6123ad04f6b07ab114a3deee2006aa..74bedc547bb154cf1ee887411e0e16ea742272d0 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 f0e2fbaea121bf7a5c726501c187640d9d1d2434..8552abe63305752a0d5532406199bec8debaf96c 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 392fbd83bf6d02424d0f6d54bb0187c579105eab..adf6ff06186c8cd7505ebb082d3566ffeb8ec2ea 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 9488869efdef60d46e7ab06b33e52d42ef1928c8..3de04fea68447bf3de515ac5d817c08f7a7fe4dd 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 cbf56dbb33beae39e43e2ef5e31c623a938b9001..6a80a822f6b01151a22364b417367d6bcbf33bda 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