Added comments to boarddriver.h

2024-08-23 17:48:54 -04:00
parent 5ba5924a29
commit 5caa0a8a61
2 changed files with 43 additions and 0 deletions
--- a/lib/Board/Board.h
+++ b/lib/Board/Board.h
@@ -1,3 +1,8 @@
+/**
+ * @file Board.h
+ * @brief The Board class is meant to store data about each cube on the board and 
+ * provide an easy way to organize and access that data in a 3-dimensional context.
+ */
 #pragma once

 #include <cstdint>