From 7da3ec62353c027d61850c7cef745a32288a3332 Mon Sep 17 00:00:00 2001
From: Brendan Bartels <bbartels@iastate.edu>
Date: Tue, 28 Mar 2017 22:25:29 -0500
Subject: [PATCH] quad: Add docstring for hw_iface
---
quad/src/quad_app/hw_iface.h | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/quad/src/quad_app/hw_iface.h b/quad/src/quad_app/hw_iface.h
index bbd6bb6fc..bde0aa3f8 100644
--- a/quad/src/quad_app/hw_iface.h
+++ b/quad/src/quad_app/hw_iface.h
@@ -1,6 +1,20 @@
#ifndef HW_IFACE_H
#define HW_IFACE_H
+/**
+ * Hardware Interfaces
+ *
+ * These interfaces are used to accomplish separation between the application
+ * layer and the hardware layer in the program that runs on the quadcopter.
+ *
+ * NOTE:
+ * If you wound up here after following some IDE function declaration trail,
+ * you've hit the end of the application layer. Go to the location of the
+ * hardware layer appropriate for your circumstance:p
+ * ../../xsdk_worksapce/modular_quad_pid -> running quad_app on the Zybo
+ * ../virt_quad -> running quad_app in a Unix environment
+ */
+
struct I2CDriver {
void *state;
int (*reset)(struct I2CDriver *self);
--
GitLab