📝 Update some pins comments

MarlinFirmware · Oct 3, 2021 · ded719c · ded719c
1 parent 2630eef
commit ded719c
Show file tree

Hide file tree

Showing 17 changed files with 45 additions and 17 deletions.
diff --git a/Marlin/src/pins/esp32/pins_E4D.h b/Marlin/src/pins/esp32/pins_E4D.h
@@ -22,9 +22,10 @@
 #pragma once
 
 /**
- * E4d@Box  pin assignments
- * E4d@Box is a small factor 3D printer control board based on the ESP32 microcontroller for Laser, CNC and 3d printers
- * for more info check https://atbox.tech/ and join to Facebook page E4d@box.
+ * E4d@box pin assignments
+ *
+ * Small factor 3D printer control board based on the ESP32 microcontroller for Laser, CNC and 3D printers.
+ * More info at https://atbox.tech/ and the E4d@box Facebook page.
  */
 
 #include "env_validate.h"
@@ -35,7 +36,7 @@
   #error "E4d@box only supports one hotend / E-stepper. Comment out this line to continue."
 #endif
 
-#define BOARD_INFO_NAME       "E4D@BOX"
+#define BOARD_INFO_NAME       "E4d@box"
 #define BOARD_WEBSITE_URL     "github.com/Exilaus/E4d@box"
 #define DEFAULT_MACHINE_NAME  BOARD_INFO_NAME
 

diff --git a/Marlin/src/pins/esp32/pins_FYSETC_E4.h b/Marlin/src/pins/esp32/pins_FYSETC_E4.h
@@ -23,7 +23,8 @@
 
 /**
  * FYSETC E4 pin assignments
- * FYSETC E4 is a 3D printer control board based on the ESP32 microcontroller.
+ *
+ * 3D printer control board based on the ESP32 microcontroller.
  * Supports 4 stepper drivers, heated bed, single hotend.
  */
 

diff --git a/Marlin/src/pins/esp32/pins_MRR_ESPA.h b/Marlin/src/pins/esp32/pins_MRR_ESPA.h
@@ -23,7 +23,8 @@
 
 /**
  * MRR ESPA pin assignments
- * MRR ESPA is a 3D printer control board based on the ESP32 microcontroller.
+ *
+ * 3D printer control board based on the ESP32 microcontroller.
  * Supports 4 stepper drivers, heated bed, single hotend.
  */
 

diff --git a/Marlin/src/pins/esp32/pins_MRR_ESPE.h b/Marlin/src/pins/esp32/pins_MRR_ESPE.h
@@ -23,7 +23,8 @@
 
 /**
  * MRR ESPE pin assignments
- * MRR ESPE is a 3D printer control board based on the ESP32 microcontroller.
+ *
+ * 3D printer control board based on the ESP32 microcontroller.
  * Supports 5 stepper drivers (using I2S stepper stream), heated bed,
  * single hotend, and LCD controller.
  */

diff --git a/Marlin/src/pins/lpc1768/pins_BIQU_BQ111_A4.h b/Marlin/src/pins/lpc1768/pins_BIQU_BQ111_A4.h
@@ -22,11 +22,7 @@
 #pragma once
 
 /**
- * BIQU BQ111-A4
- *
- * Applies to the following boards:
- *
- *  BOARD_BIQU_BQ111_A4 (Hotend, Fan, Bed)
+ * BIQU BQ111-A4 pin assignments
  */
 
 #include "env_validate.h"

diff --git a/Marlin/src/pins/lpc1768/pins_BTT_SKR_V1_1.h b/Marlin/src/pins/lpc1768/pins_BTT_SKR_V1_1.h
@@ -21,6 +21,10 @@
  */
 #pragma once
 
+/**
+ * BigTreeTech SKR 1.1 pin assignments
+ */
+
 #define BOARD_INFO_NAME "BTT SKR V1.1"
 
 //

diff --git a/Marlin/src/pins/lpc1768/pins_BTT_SKR_V1_3.h b/Marlin/src/pins/lpc1768/pins_BTT_SKR_V1_3.h
@@ -21,6 +21,10 @@
  */
 #pragma once
 
+/**
+ * BigTreeTech SKR 1.3 pin assignments
+ */
+
 #define BOARD_INFO_NAME "BTT SKR V1.3"
 #define LPC1768_IS_SKRV1_3 1
 

diff --git a/Marlin/src/pins/lpc1768/pins_BTT_SKR_V1_4.h b/Marlin/src/pins/lpc1768/pins_BTT_SKR_V1_4.h
@@ -21,6 +21,10 @@
  */
 #pragma once
 
+/**
+ * BigTreeTech SKR 1.4 pin assignments
+ */
+
 #include "env_validate.h"
 
 #ifndef BOARD_INFO_NAME

diff --git a/Marlin/src/pins/lpc1768/pins_GMARSH_X6_REV1.h b/Marlin/src/pins/lpc1768/pins_GMARSH_X6_REV1.h
@@ -21,6 +21,10 @@
  */
 #pragma once
 
+/**
+ * GMARSH X6 Rev.1 pin assignments
+ */
+
 #include "env_validate.h"
 
 #define BOARD_INFO_NAME "GMARSH X6 REV1"

diff --git a/Marlin/src/pins/lpc1768/pins_MKS_SBASE.h b/Marlin/src/pins/lpc1768/pins_MKS_SBASE.h
@@ -22,7 +22,7 @@
 #pragma once
 
 /**
- * MKS SBASE pin assignments
+ * Makerbase MKS SBASE pin assignments
  */
 
 #include "env_validate.h"

diff --git a/Marlin/src/pins/lpc1768/pins_MKS_SGEN_L.h b/Marlin/src/pins/lpc1768/pins_MKS_SGEN_L.h
@@ -22,7 +22,7 @@
 #pragma once
 
 /**
- * MKS SGEN-L pin assignments
+ * Makerbase MKS SGEN-L pin assignments
  */
 
 #include "env_validate.h"

diff --git a/Marlin/src/pins/lpc1769/pins_BTT_SKR_E3_TURBO.h b/Marlin/src/pins/lpc1769/pins_BTT_SKR_E3_TURBO.h
@@ -21,6 +21,10 @@
  */
 #pragma once
 
+/**
+ * BigTreeTech SKR E3 Turbo pin assignments
+ */
+
 #include "env_validate.h"
 
 #ifndef BOARD_INFO_NAME

diff --git a/Marlin/src/pins/lpc1769/pins_BTT_SKR_V1_4_TURBO.h b/Marlin/src/pins/lpc1769/pins_BTT_SKR_V1_4_TURBO.h
@@ -21,6 +21,10 @@
  */
 #pragma once
 
+/**
+ * BigTreeTech SKR 1.4 Turbo pin assignments
+ */
+
 #define BOARD_INFO_NAME "BTT SKR V1.4 TURBO"
 
 //

diff --git a/Marlin/src/pins/lpc1769/pins_FLY_CDY.h b/Marlin/src/pins/lpc1769/pins_FLY_CDY.h
@@ -21,6 +21,10 @@
  */
 #pragma once
 
+/**
+ * FLYmaker FLY-CDY pin assignments
+ */
+
 #include "env_validate.h"
 
 #define BOARD_INFO_NAME   "FLY-CDY"

diff --git a/Marlin/src/pins/lpc1769/pins_MKS_SGEN.h b/Marlin/src/pins/lpc1769/pins_MKS_SGEN.h
@@ -24,7 +24,7 @@
 /**
  * MKS SGen pin assignments
  *
- * The pins diagram can be found and the following URL:
+ * Pins diagram:
  * https://github.com/makerbase-mks/MKS-SGen/blob/master/Hardware/MKS%20SGEN%20V1.0_001/MKS%20SGEN%20V1.0_001%20PIN.pdf
  */
 

diff --git a/Marlin/src/pins/lpc1769/pins_MKS_SGEN_L_V2.h b/Marlin/src/pins/lpc1769/pins_MKS_SGEN_L_V2.h
@@ -22,7 +22,7 @@
 #pragma once
 
 /**
- * MKS SGen pin assignments
+ * MKS SGen-L V2 pin assignments
  */
 
 #include "env_validate.h"

diff --git a/Marlin/src/pins/lpc1769/pins_SMOOTHIEBOARD.h b/Marlin/src/pins/lpc1769/pins_SMOOTHIEBOARD.h
@@ -22,7 +22,7 @@
 #pragma once
 
 /**
- * Smoothieboard pin assignments
+ * Smoothieware Smoothieboard pin assignments
  */
 
 #include "env_validate.h"
-Original file line number
+Diff line change
@@ Expand Up / @@ -21,6 +21,10 @@ @@
      */
     #pragma once
+    /**
+     * BigTreeTech SKR 1.1 pin assignments
+     */
     #define BOARD_INFO_NAME "BTT SKR V1.1"
     //
@@ Expand Down @@