Skip to content

Commit 93a084d

Browse files
Update - adjust /pins comments
1 parent a32d8d6 commit 93a084d

File tree

5 files changed

+34
-35
lines changed

5 files changed

+34
-35
lines changed

Marlin/src/pins/pins.h

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,7 @@
2222
#pragma once
2323

2424
/**
25-
* File: pins/pins.h
26-
*
27-
* Include pins definitions
25+
* pins.h - Include pins definitions
2826
*
2927
* Pins numbering schemes:
3028
*

Marlin/src/pins/pinsDebug.h

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@
2727
// "-" left justify, "39" minimum width of name, pad with blanks
2828

2929
/**
30-
* This routine minimizes RAM usage by creating a FLASH resident array to
31-
* store the pin names, pin numbers and analog/digital flag.
30+
* This routine minimizes RAM usage by creating a FLASH resident array to
31+
* store the pin names, pin numbers and analog/digital flag.
3232
*
33-
* Creating the array in FLASH is a two pass process. The first pass puts the
34-
* name strings into FLASH. The second pass actually creates the array.
33+
* Creating the array in FLASH is a two pass process. The first pass puts the
34+
* name strings into FLASH. The second pass actually creates the array.
3535
*
36-
* Both passes use the same pin list. The list contains two macro names. The
37-
* actual macro definitions are changed depending on which pass is being done.
36+
* Both passes use the same pin list. The list contains two macro names. The
37+
* actual macro definitions are changed depending on which pass is being done.
3838
*/
3939

4040
// first pass - put the name strings into FLASH
@@ -90,12 +90,12 @@ typedef struct {
9090
const PinInfo pin_array[] PROGMEM = {
9191

9292
/**
93-
* [pin name] [pin number] [is digital or analog] 1 = digital, 0 = analog
94-
* Each entry takes up 6 bytes in FLASH:
95-
* 2 byte pointer to location of the name string
96-
* 2 bytes containing the pin number
97-
* analog pin numbers were converted to digital when the array was created
98-
* 2 bytes containing the digital/analog bool flag
93+
* [pin name] [pin number] [is digital or analog] 1 = digital, 0 = analog
94+
* Each entry takes up 6 bytes in FLASH:
95+
* 2 byte pointer to location of the name string
96+
* 2 bytes containing the pin number
97+
* analog pin numbers were converted to digital when the array was created
98+
* 2 bytes containing the digital/analog bool flag
9999
*/
100100

101101
#if SERIAL_IN_USE(0)

Marlin/src/pins/pinsDebug_list.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,12 @@
2020
*
2121
*/
2222

23-
// Please update this list when adding new pins to Marlin.
24-
// The order doesn't matter.
25-
// Following this pattern is a must.
26-
// If the new pin name is over 28 characters long then pinsDebug.h will need to be modified.
23+
/**
24+
* Please update this list when adding new pins to Marlin.
25+
* The order doesn't matter.
26+
* Following this pattern is a must.
27+
* If the new pin name is over 28 characters long then pinsDebug.h will need to be modified.
28+
*/
2729

2830
#if TARGET_LPC1768
2931
#define ANALOG_OK(PN) (WITHIN(PN, P0_02, P0_03) || WITHIN(PN, P0_23, P0_26) || WITHIN(PN, P1_30, P1_31))
@@ -38,7 +40,6 @@
3840
//
3941
// Analog Pin Assignments
4042
//
41-
4243
#define _EXISTS(PN,V...) (defined(PN##V) && PN##V >= 0)
4344

4445
#if _EXISTS(EXT_AUX_A0)
@@ -177,7 +178,6 @@
177178
//
178179
// Digital Pin Assignments
179180
//
180-
181181
#if _EXISTS(__FD)
182182
REPORT_NAME_DIGITAL(__LINE__, __FD)
183183
#endif

Marlin/src/pins/pins_postprocess.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,13 @@
2121
*/
2222
#pragma once
2323

24-
//
25-
// File: pins/pins_postprocess.h
26-
// Post-process pins according to configured settings
27-
//
24+
/**
25+
* pins_postprocess.h - Post-process pins according to configured settings
26+
*/
2827

28+
//
2929
// Define certain undefined pins
30+
//
3031
#ifndef X_MS1_PIN
3132
#define X_MS1_PIN -1
3233
#endif
@@ -627,7 +628,6 @@
627628
//
628629
// Assign endstop pins, with handling for boards that have only 3 connectors
629630
//
630-
631631
#if HAS_X_AXIS
632632
#if PIN_EXISTS(X_STOP)
633633
#if X_HOME_TO_MIN

Marlin/src/pins/sensitive_pins.h

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,13 @@
2323

2424
#include <stdint.h>
2525

26-
//
27-
// Define unsorted and arrays of pins which may have duplicstes,
28-
// but don't allocate any runtime memory for these arrays.
29-
// We'll use constexpr functions to get the Nth distinct value,
30-
// and return -1 if we go past the end of the array.
31-
//
26+
/**
27+
* Define unsorted and arrays of pins which may have duplicstes,
28+
* but don't allocate any runtime memory for these arrays.
29+
* We'll use constexpr functions to get the Nth distinct value,
30+
* and return -1 if we go past the end of the array.
31+
*/
32+
3233
constexpr pin_t sensitive_dio[] PROGMEM = {
3334

3435
#if HAS_X_AXIS
@@ -558,12 +559,12 @@ constexpr pin_t sensitive_dio[] PROGMEM = {
558559
#endif
559560

560561
#if TEMP_SENSOR_COOLER && PIN_EXISTS(TEMP_COOLER)
561-
#if PIN_EXISTS(COOLER_AUTO_FAN)
562-
COOLER_AUTO_FAN_PIN,
563-
#endif
564562
#if PIN_EXISTS(COOLER)
565563
COOLER_PIN,
566564
#endif
565+
#if PIN_EXISTS(COOLER_AUTO_FAN)
566+
COOLER_AUTO_FAN_PIN,
567+
#endif
567568
#endif
568569

569570
#ifdef HAL_SENSITIVE_PINS

0 commit comments

Comments
 (0)