Diff: Front/Front.h

Revision:

21:60f01b17b0a6

Parent:

19:08862f49cd9e

Child:

24:c3bb1b0b2207

diff -r fe235c124c67 -r 60f01b17b0a6 Front/Front.h
--- a/Front/Front.h	Fri May 22 21:11:12 2020 +0000
+++ b/Front/Front.h	Sat May 23 14:40:40 2020 +0000
@@ -29,19 +29,21 @@
     uint16_t out;
 
     //Methods
-    //Constructor
+    /** Constructor */
     Front();
 
-    //Destructior
+    /** Destructior */
     ~Front();
 
-    //Runs whole front pannel
+    /** Runs whole front pannel 
+    * @function to process whole front pannel
+    * Deals with ADSR and sound generation bby calling other classes */
     void frontrun(N5110 &lcd, Gamepad &pad, int submenu);
 
 
 private:
 //variables
-    int menuflag;
+    int menuflag; //Flag to exit front function or change menu
     int used; //1->4 (A<D<S<R)
     bool use; //1=use 0=!use
     bool initial; //sets to run 1st time
@@ -50,34 +52,44 @@
     bool noteon; //trigger for play tone
     int release_flag; //sets 1 for if release on
     
-    #ifdef CSV
-    int itterator;
+    #ifdef CSV //COMMA SEPERATED VALUE
+    int itterator; //Itterator for CSV
     #endif
 
 //methods
-    //initial setup of front panel
+    /** initial setup of front panel
+    */
     void frontsetup(N5110 &lcd, Gamepad &pad, int submenu, bool initial);
 
-    //prints waveforms for front disp.
+    /**prints waveforms for front disp. to LCD
+    */
     void printwav(N5110 &lcd, int submenu);
 
-    //prints fader
+    /**prints single fader to LCD 
+    */
     void printfader(N5110 &lcd,int x, int y);
 
-    //prints sliders
+    /**prints all ADSR sliders to LCD 
+    */
     void printsliders(N5110 &lcd, int a, int d,int s,int r, int used);
 
-    //prints individual slider
+    /**prints individual slider to LCD
+    */
     void printslider(N5110 &lcd, int x_val, int y_val, bool use);
 
-    //incraments correct adsr value
+    /**incraments correct adsr value
+    * @outputs new ADSR value when called
+    */
     int incrament_adsr(int used, int adsr, int ud);
     
     //pre compilation directive function
     #ifdef SLOW_TIME
-    //prints slow time front values output from loop
+    /**prints slow time front values output from loop
+    * @prints values to pc if SLOW_TIME Macro used
+    */
     void print_SLOWTIME_out (uint16_t out, bool noteon, int a, int d, int s, int r, int release_flag, int silent_flag);
     #endif
+    
 };
 
 #endif
\ No newline at end of file