Merge pull request #4690 from 3d-gussner/MK3_Documentation

Update doxygen documentation remove white spaces

.github/ISSUE_TEMPLATE/bug_report.md

@@ -20,13 +20,13 @@ Please, before you create a new bug report, please make sure you searched in ope
 
 **Describe the bug**
   A clear and concise description of what the bug is.
-  
+
 **To Reproduce**
   Please describe steps to reproduce the behavior.
-  
+
 **Expected behavior**
   A clear and concise description of what you expected to happen.
-  
+
 **G-code**
   Please attach a G-code. This will make it easier for us to replicate the error.
 

.github/ISSUE_TEMPLATE/enhancement.md

@@ -15,6 +15,6 @@ Enter what type of printer or upgrade the enhancement applies to.
 
 **Is your enhancement related to a problem? Please describe.**
   A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-  
+
 **Describe the solution you'd like**
   A clear and concise description of what you want to happen.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -15,6 +15,6 @@ If it makes sense, enter what type of printer or upgrade the feature request app
 
 **Is your feature request related to a problem? Please describe.**
   A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-  
+
 **Describe the solution you'd like**
   A clear and concise description of what you want to happen.

.github/workflows/stale.yml

@@ -17,8 +17,8 @@ jobs:
         # Don't ever mark PRs as stale.
         days-before-pr-stale: -1
         stale-issue-message: 'This issue has been flagged as stale because it has been open for 60 days with no activity. The issue will be closed in 7 days unless someone removes the "stale" label or adds a comment.'
-        close-issue-message: 'This issue has been closed due to lack of recent activity. Please consider opening a new one if needed.' 
-        # Don't act on things assigned to a milestone or assigned to someone. 
+        close-issue-message: 'This issue has been closed due to lack of recent activity. Please consider opening a new one if needed.'
+        # Don't act on things assigned to a milestone or assigned to someone.
         exempt-all-milestones: true
         exempt-all-assignees: true
         enable-statistics: true

Community_made.md

@@ -16,7 +16,7 @@ Help `./PF-build.sh -h`
 
 # MK404 Simulator
 
-## MK404-build.sh 
+## MK404-build.sh
 **MK404 is a community 3d printer simulator created by @vintagepc**
 Please checkout and support his github repository [MK404](https://github.com/vintagepc/MK404) and the [MK404 Wiki](https://github.com/vintagepc/MK404/wiki)
 

Firmware/BlinkM.cpp

@@ -15,7 +15,7 @@
 
 void SendColors(byte red, byte grn, byte blu)
 {
-  Wire.begin(); 
+  Wire.begin();
   Wire.beginTransmission(0x09);
   Wire.write('o');                    //to disable ongoing script, only needs to be used once
   Wire.write('n');

Firmware/ConfigurationStore.cpp

@@ -206,7 +206,7 @@ bool Config_RetrieveSettings()
         eeprom_init_default_byte(&EEPROM_M500_base->n_arc_correction, pgm_read_byte(&default_conf.n_arc_correction));
         eeprom_init_default_word(&EEPROM_M500_base->min_arc_segments, pgm_read_word(&default_conf.min_arc_segments));
         eeprom_init_default_word(&EEPROM_M500_base->arc_segments_per_sec, pgm_read_word(&default_conf.arc_segments_per_sec));
-        
+
         // Initialize the travel_acceleration in eeprom if not already
         eeprom_init_default_float(&EEPROM_M500_base->travel_acceleration, pgm_read_float(&default_conf.travel_acceleration));
 
@@ -271,7 +271,7 @@ void Config_ResetDefault()
 
   // steps per sq second need to be updated to agree with the units per sq second
     reset_acceleration_rates();
-    
+
 #ifdef PIDTEMP
     updatePID();
 #endif//PIDTEMP

Firmware/Configuration_adv.h

@@ -54,7 +54,7 @@
 
 /**
  * Auto-report all at once with M155 S<seconds> C[bitmask] with single timer
- * 
+ *
  * bit 0 = Auto-report temperatures
  * bit 1 = Auto-report fans
  * bit 2 = Auto-report position
@@ -229,7 +229,7 @@
 * limit is exceeded.
 */
 	#define SDCARD_SORT_ALPHA //Alphabetical sorting of SD files menu
-	
+
 	// SD Card Sorting options
 	#ifdef SDCARD_SORT_ALPHA
 	  #define SD_SORT_TIME 0
@@ -238,11 +238,11 @@
 	  #define INSERTSORT
 	  // #define SORTING_DUMP
 	  // #define SORTING_SPEEDTEST
-	
+
 	  #define SDSORT_LIMIT       100    // Maximum number of sorted items (10-256).
 	  #define FOLDER_SORTING     -1     // -1=above  0=none  1=below
 	#endif
-	
+
 	#if defined(SDCARD_SORT_ALPHA)
 	  #define HAS_FOLDER_SORTING (FOLDER_SORTING)
 	#endif
@@ -392,7 +392,7 @@ const unsigned int dropsegments=5; //everything with less than this number of st
 
 /**
  * Enable M120/M121 G-code commands
- * 
+ *
  */
 //#define M120_M121_ENABLED  //Be careful enabling and using these G-code commands.
 

Firmware/Dcodes.cpp

@@ -162,19 +162,19 @@ void dcode_core(daddr_t addr_start, const daddr_t addr_end, const dcode_mem_t ty
     ### D3 - Read/Write EEPROM <a href="https://reprap.org/wiki/G-code#D3:_Read.2FWrite_EEPROM">D3: Read/Write EEPROM</a>
     This command can be used without any additional parameters. It will read the entire eeprom.
     #### Usage
-    
+
         D3 [ A | C | X ]
-    
+
     #### Parameters
     - `A` - Address (x0000-x0fff)
     - `C` - Count (1-4096)
     - `X` - Data (hex)
-	
+
 	#### Notes
 	- The hex address needs to be lowercase without the 0 before the x
-	- Count is decimal 
+	- Count is decimal
 	- The hex data needs to be lowercase
-	
+
     */
 void dcode_3()
 {
@@ -203,9 +203,9 @@ extern float axis_steps_per_mm[NUM_AXIS];
     /*!
     *
     ### D-1 - Endless Loop <a href="https://reprap.org/wiki/G-code#G28:_Move_to_Origin_.28Home.29">D-1: Endless Loop</a>
-      
+
           D-1
-      
+
     *
     */
 void dcode__1()
@@ -220,9 +220,9 @@ void dcode__1()
     /*!
     ### D0 - Reset <a href="https://reprap.org/wiki/G-code#D0:_Reset">D0: Reset</a>
     #### Usage
-    
+
         D0 [ B ]
-    
+
     #### Parameters
     - `B` - Bootloader
     */
@@ -245,9 +245,9 @@ void dcode_0()
     /*!
     *
     ### D1 - Clear EEPROM and RESET <a href="https://reprap.org/wiki/G-code#D1:_Clear_EEPROM_and_RESET">D1: Clear EEPROM and RESET</a>
-      
+
           D1
-      
+
     *
     */
 void dcode_1()
@@ -287,13 +287,13 @@ void dcode_2()
 
 #ifdef DEBUG_DCODES
     /*!
-    
+
     ### D4 - Read/Write PIN <a href="https://reprap.org/wiki/G-code#D4:_Read.2FWrite_PIN">D4: Read/Write PIN</a>
     To read the digital value of a pin you need only to define the pin number.
     #### Usage
-    
+
         D4 [ P | F | V ]
-    
+
     #### Parameters
     - `P` - Pin (0-255)
     - `F` - Function in/out (0/1)
@@ -335,20 +335,19 @@ void dcode_4()
     ### D5 - Read/Write FLASH <a href="https://reprap.org/wiki/G-code#D5:_Read.2FWrite_FLASH">D5: Read/Write Flash</a>
     This command can be used without any additional parameters. It will read the 1kb FLASH.
     #### Usage
-    
+
         D5 [ A | C | X | E ]
-    
+
     #### Parameters
     - `A` - Address (x00000-x3ffff)
     - `C` - Count (1-8192)
     - `X` - Data (hex)
     - `E` - Erase
- 	
+
 	#### Notes
 	- The hex address needs to be lowercase without the 0 before the x
-	- Count is decimal 
+	- Count is decimal
 	- The hex data needs to be lowercase
-	
    */
 void dcode_5()
 {
@@ -457,9 +456,9 @@ void dcode_7()
     /*!
     ### D8 - Read/Write PINDA <a href="https://reprap.org/wiki/G-code#D8:_Read.2FWrite_PINDA">D8: Read/Write PINDA</a>
     #### Usage
-    
+
         D8 [ ? | ! | P | Z ]
-    
+
     #### Parameters
     - `?` - Read PINDA temperature shift values
     - `!` - Reset PINDA temperature shift values to default
@@ -510,11 +509,11 @@ void dcode_8()
     /*!
     ### D9 - Read ADC <a href="https://reprap.org/wiki/G-code#D9:_Read.2FWrite_ADC">D9: Read ADC</a>
     #### Usage
-    
+
         D9 [ I | V ]
-    
+
     #### Parameters
-    - `I` - ADC channel index 
+    - `I` - ADC channel index
         - `0` - Heater 0 temperature
         - `1` - Heater 1 temperature
         - `2` - Bed temperature
@@ -618,9 +617,9 @@ void dcode_12()
     ### D80 - Bed check <a href="https://reprap.org/wiki/G-code#D80:_Bed_check">D80: Bed check</a>
     This command will log data to SD card file "mesh.txt".
     #### Usage
-    
+
         D80 [ E | F | G | H | I | J ]
-    
+
     #### Parameters
     - `E` - Dimension X (default 40)
     - `F` - Dimention Y (default 40)
@@ -658,9 +657,9 @@ void dcode_80()
     ### D81 - Bed analysis <a href="https://reprap.org/wiki/G-code#D81:_Bed_analysis">D80: Bed analysis</a>
     This command will log data to SD card file "wldsd.txt".
     #### Usage
-    
+
         D81 [ E | F | G | H | I | J ]
-    
+
     #### Parameters
     - `E` - Dimension X (default 40)
     - `F` - Dimention Y (default 40)
@@ -684,9 +683,9 @@ void dcode_81()
 	if (code_seen("H")) { strchr_pointer+=1; points_y = code_value(); }
 	if (code_seen("I")) { strchr_pointer+=1; offset_x = code_value(); }
 	if (code_seen("J")) { strchr_pointer+=1; offset_y = code_value(); }
-	
+
 	bed_analysis(dimension_x,dimension_y,points_x,points_y,offset_x,offset_y);
-	
+
 }
 
 #endif //HEATBED_ANALYSIS
@@ -713,11 +712,11 @@ extern void st_synchronize();
     /*!
     ### D2130 - Trinamic stepper controller <a href="https://reprap.org/wiki/G-code#D2130:_Trinamic_stepper_controller">D2130: Trinamic stepper controller</a>
     @todo Please review by owner of the code. RepRap Wiki Gcode needs to be updated after review of owner as well.
-    
+
     #### Usage
-    
+
         D2130 [ Axis | Command | Subcommand | Value ]
-    
+
     #### Parameters
     - Axis
       - `X` - X stepper driver
@@ -746,21 +745,21 @@ extern void st_synchronize();
           - `0, 180 --> 250` - Off
           - `0.9 --> 1.25`   - Valid values (recommended is 1.1)
       - `@`   - Home calibrate axis
-    
+
     Examples:
-      
+
           D2130E?wave
-      
+
       Print extruder microstep linearity compensation curve
-      
+
           D2130E!wave0
-      
+
       Disable extruder linearity compensation curve, (sine curve is used)
-      
+
           D2130E!wave220
-      
+
       (sin(x))^1.1 extruder microstep compensation curve used
-    
+
     Notes:
       For more information see https://www.trinamic.com/fileadmin/assets/Products/ICs_Documents/TMC2130_datasheet.pdf
     *
@@ -870,9 +869,9 @@ void dcode_2130()
     /*!
     ### D9125 - PAT9125 filament sensor <a href="https://reprap.org/wiki/G-code#D9:_Read.2FWrite_ADC">D9125: PAT9125 filament sensor</a>
     #### Usage
-    
+
         D9125 [ ? | ! | R | X | Y | L ]
-    
+
     #### Parameters
     - `?` - Print values
     - `!` - Print values