Add Documentation to describe the manual and the board

2026-03-25 22:06:35 -03:00
parent 93f1496dc7
commit 49aaadb28e
5 changed files with 116 additions and 10 deletions
@@ -5,15 +5,23 @@
 #ifndef YMF262DEVBOARDSOFTWARE_FNUMBERBLOCK_H
 #define YMF262DEVBOARDSOFTWARE_FNUMBERBLOCK_H

+/**
+ * @enum FNumberBlock
+ * @brief Enum Representing the concept of Block
+ *
+ * The concept of Block is tantamount to the octave in YMF 262, this enum provides the datatype
+ * to use block
+ */
+
 enum FNumberBlock {
-    BLOCK1,
-    BLOCK2,
-    BLOCK3,
-    BLOCK4,
-    BLOCK5,
-    BLOCK6,
-    BLOCK7,
-    BLOCK8,
+    BLOCK1 = 0, ///< Octave 1
+    BLOCK2 = 1, ///< Octave 2
+    BLOCK3 = 2, ///< Octave 3
+    BLOCK4 = 3, ///< Octave 4
+    BLOCK5 = 4, ///< Octave 5
+    BLOCK6 = 5, ///< Octave 6
+    BLOCK7 = 6, ///< Octave 7
+    BLOCK8 = 7, ///< Octave 8 
 };

 #endif //YMF262DEVBOARDSOFTWARE_FNUMBERBLOCK_H