added documentation comments and led map

1 files changed, 4 insertions, 0 deletions

diff --git a/software/scan.h b/software/scan.h
index 0c19763..82dccb0 100644
--- a/software/scan.h
+++ b/software/scan.h
@@ -1,13 +1,17 @@
 #pragma once
 
+// utility
 #define SCAN_HOR 0
 #define SCAN_VER 1
 extern unsigned char scan_direction;
 extern unsigned char scan_index;
 extern unsigned char scan_order[8];
 
+/** @brief fetch horizontal or vertical row from led_state */
 unsigned char get_state_row(unsigned char row, unsigned char direction);
 
+/** @brief scan through the 8x8 wiring matrix and display led_state */
 void scan();
+/** @brief optimize brightness by pruning empty lines */
 void optimize_scan();