Update - use ///TODO:

classicrocker883 · classicrocker883 · commit 5b4684ddfc89 · 2025-11-15T03:50:21.000-05:00
diff --git a/Marlin/src/HAL/GD32_MFL/temp_soc.h b/Marlin/src/HAL/GD32_MFL/temp_soc.h
@@ -25,5 +25,5 @@
 #define TS_TYPICAL_TEMP   25
 #define TS_TYPICAL_SLOPE  4.5
 
-// TODO: Implement voltage scaling (calibrated Vrefint) and ADC resolution scaling (when applicable)
+/// TODO: Implement voltage scaling (calibrated Vrefint) and ADC resolution scaling (when applicable)
 #define TEMP_SOC_SENSOR(RAW) ((TS_TYPICAL_V - (RAW) / float(OVERSAMPLENR) / float(HAL_ADC_RANGE) * (float(ADC_VREF_MV) * 0.001f)) / ((TS_TYPICAL_SLOPE) * 0.001f) + TS_TYPICAL_TEMP)
diff --git a/Marlin/src/HAL/HC32/MarlinHAL.cpp b/Marlin/src/HAL/HC32/MarlinHAL.cpp
@@ -300,7 +300,7 @@ void MarlinHAL::set_pwm_duty(const pin_t pin, const uint16_t value, const uint16
 }
 
 void MarlinHAL::set_pwm_frequency(const pin_t pin, const uint16_t f_desired) {
-  // TODO set_pwm_frequency is not implemented yet
+  /// TODO: set_pwm_frequency is not implemented yet
   panic("set_pwm_frequency is not implemented yet\n");
 }
 
diff --git a/Marlin/src/HAL/HC32/MarlinSerial.cpp b/Marlin/src/HAL/HC32/MarlinSerial.cpp
@@ -70,7 +70,7 @@ constexpr bool serial_handles_emergency(int port) {
 DEFINE_SERIAL_MARLIN(MSerial1, 1);
 DEFINE_SERIAL_MARLIN(MSerial2, 2);
 
-// TODO: remove this warning when SERIAL_DMA has been tested some more
+/// TODO: remove this warning when SERIAL_DMA has been tested some more
 #if ENABLED(SERIAL_DMA)
   #warning "SERIAL_DMA may be unstable on HC32F460."
 #endif
diff --git a/Marlin/src/HAL/HC32/MinSerial.cpp b/Marlin/src/HAL/HC32/MinSerial.cpp
@@ -64,7 +64,7 @@ static void minserial_begin() {
     // keeping the dynamic baudrate would require re-calculating the baudrate
     // using the register values, which is a pain...
 
-    // TODO: retain dynamic baudrate in MinSerial init
+    /// TODO: retain dynamic baudrate in MinSerial init
     // -> see USART_SetBaudrate(), needs to be inverted
     USART_SYNC_INIT(SERIAL_PORT, BAUDRATE, &usart_config);
 
diff --git a/Marlin/src/HAL/HC32/sysclock.cpp b/Marlin/src/HAL/HC32/sysclock.cpp
@@ -166,7 +166,7 @@ void core_hook_sysclock_init() {
     sysclock_configure_hrc();
 
     // HRC could have been configured by ICG to 20 MHz
-    // TODO: handle gracefully if HRC is not 16 MHz
+    /// TODO: handle gracefully if HRC is not 16 MHz
     if (1UL != (HRC_FREQ_MON() & 1UL)) {
       panic("HRC is not 16 MHz");
     }
diff --git a/Marlin/src/HAL/SAMD21/pinsDebug.h b/Marlin/src/HAL/SAMD21/pinsDebug.h
@@ -66,7 +66,8 @@ bool getValidPinMode(const int8_t pin) {  // 1: output, 0: input
 
 void printPinPWM(const int32_t pin) {
   if (pwm_status(pin)) {
-    //uint32_t chan = g_APinDescription[pin].ulPWMChannel TODO when fast pwm is operative;
+    //uint32_t chan = g_APinDescription[pin].ulPWMChannel
+    /// TODO: when fast pwm is operative;
     //SERIAL_ECHOPGM("PWM = ", duty);
   }
 }
diff --git a/Marlin/src/HAL/STM32/sd/msc_sd.cpp b/Marlin/src/HAL/STM32/sd/msc_sd.cpp
@@ -48,7 +48,7 @@
 class Sd2CardUSBMscHandler : public USBMscHandler {
 public:
   DiskIODriver* diskIODriver() {
-    // TODO: Explore a variable shared volume, or auto share the un-mounted volume(s)
+    /// TODO: Explore a variable shared volume, or auto share the un-mounted volume(s)
     #if HAS_MULTI_VOLUME
       #if SHARED_VOLUME_IS(SD_ONBOARD)
         return &card.media_driver_sdcard;
diff --git a/Marlin/src/HAL/STM32/temp_soc.h b/Marlin/src/HAL/STM32/temp_soc.h
@@ -326,7 +326,7 @@
   #define TS_CAL2_REGOFFSET 0x1FFF75CA
 #endif
 
-// TODO implement voltage scaling (calibrated Vrefint) and ADC resolution scaling (when applicable)
+/// TODO: implement voltage scaling (calibrated Vrefint) and ADC resolution scaling (when applicable)
 
 /**
  * When provided in datasheet, the use of calibrated values (TS_CAL1, TS_CAL2) should always be preferred over typical values.
diff --git a/Marlin/src/HAL/STM32F1/HAL.cpp b/Marlin/src/HAL/STM32F1/HAL.cpp
@@ -293,7 +293,8 @@ void MarlinHAL::idletask() {
      * command so drives can be released as needed.
      */
     /* Copied from LPC1768 framework. Should be fixed later to process HAS_SD_HOST_DRIVE */
-    //if (!drive_locked()) // TODO
+    //if (!drive_locked())
+    /// TODO:
     MarlinMSC.loop(); // Process USB mass storage device class loop
   #endif
 }
diff --git a/Marlin/src/HAL/STM32F1/timers.h b/Marlin/src/HAL/STM32F1/timers.h
@@ -120,7 +120,7 @@ timer_dev* HAL_get_timer_dev(int number);
 
 #define HAL_timer_get_count(timer_num) timer_get_count(TIMER_DEV(timer_num))
 
-// TODO change this
+/// TODO: change this
 
 #ifndef HAL_TEMP_TIMER_ISR
   #define HAL_TEMP_TIMER_ISR() extern "C" void tempTC_Handler()
diff --git a/Marlin/src/feature/bedlevel/ubl/ubl_G29.cpp b/Marlin/src/feature/bedlevel/ubl/ubl_G29.cpp
@@ -1129,11 +1129,11 @@ void set_message_with_feedback(FSTR_P const fstr) {
         set_message_with_feedback(GET_TEXT_F(MSG_EDITING_STOPPED));
       })) break;
 
-      // TODO: Disable leveling here so the Z value becomes the 'native' Z value.
+      /// TODO: Disable leveling here so the Z value becomes the 'native' Z value.
 
       z_values[lpos.x][lpos.y] = new_z;                   // Save the updated Z value
 
-      // TODO: Re-enable leveling here so Z is correctly based on the updated mesh.
+      /// TODO: Re-enable leveling here so Z is correctly based on the updated mesh.
 
       TERN_(EXTENSIBLE_UI, ExtUI::onMeshUpdate(location, new_z));
 
diff --git a/Marlin/src/feature/mmu3/SpoolJoin.cpp b/Marlin/src/feature/mmu3/SpoolJoin.cpp
@@ -50,7 +50,7 @@ void SpoolJoin::toggle() {
   FLIP(enabled);
 
   // Following Prusa's implementation let's save the value to the EEPROM
-  // TODO: Move to settings.cpp
+  /// TODO: Move to settings.cpp
   #if ENABLED(EEPROM_SETTINGS)
     persistentStore.access_start();
     persistentStore.write_data(epprom_addr, enabled);
diff --git a/Marlin/src/feature/mmu3/mmu3.cpp b/Marlin/src/feature/mmu3/mmu3.cpp
@@ -84,7 +84,7 @@ namespace MMU3 {
   int MMU3::cutter_mode_addr;   // Initialized by settings.load
   uint8_t MMU3::stealth_mode;   // Initialized by settings.load
   int MMU3::stealth_mode_addr;  // Initialized by settings.load
-  // TODO: Currently, by logic, the value stored in the EEPROM for is ignored and
+  /// TODO: Currently, by logic, the value stored in the EEPROM for is ignored and
   //       mmu_hw_enabled is always overwritten by the MMU State. Thus restarting
   //       printer will always set the MMU as senabled.
   bool MMU3::mmu_hw_enabled;    // Initialized by settings.load
@@ -114,7 +114,7 @@ namespace MMU3 {
 
     #if ENABLED(EEPROM_SETTINGS)
       // Save mmu_hw_enabled to EEPROM
-      // TODO: Move to settings.cpp (for now)
+      /// TODO: Move to settings.cpp (for now)
       persistentStore.access_start();
       persistentStore.write_data(mmu_hw_enabled_addr, mmu_hw_enabled);
       persistentStore.access_finish();
diff --git a/Marlin/src/feature/mmu3/mmu3_marlin1.cpp b/Marlin/src/feature/mmu3/mmu3_marlin1.cpp
@@ -135,12 +135,12 @@ namespace MMU3 {
 
   void marlin_refresh_print_state_in_ram() {
     // refresh_print_state_in_ram();
-    // TODO: I don't see a comparable implementation in Marlin.
+    /// TODO: I don't see a comparable implementation in Marlin.
   }
 
   void marlin_clear_print_state_in_ram() {
     // clear_print_state_in_ram();
-    // TODO: I don't see a comparable implementation in Marlin.
+    /// TODO: I don't see a comparable implementation in Marlin.
   }
 
   void marlin_stop_and_save_print_to_ram() {
diff --git a/Marlin/src/feature/mmu3/mmu3_power.cpp b/Marlin/src/feature/mmu3/mmu3_power.cpp
@@ -55,7 +55,8 @@ void power_reset() {
     safe_delay(100);
     WRITE(MMU_RST_PIN, HIGH);
   #else
-    mmu3.reset(MMU3::Software); // TODO: Needs redesign. This power implementation shouldn't know anything about the MMU itself
+    mmu3.reset(MMU3::Software);
+    /// TODO: Needs redesign. This power implementation shouldn't know anything about the MMU itself
   #endif
   // otherwise HW reset is not available
 }
diff --git a/Marlin/src/feature/mmu3/mmu3_progress_converter.cpp b/Marlin/src/feature/mmu3/mmu3_progress_converter.cpp
@@ -36,7 +36,7 @@
 namespace MMU3 {
 
   FSTR_P const progressTexts[] PROGMEM = {
-    GET_TEXT_F(MSG_PROGRESS_OK),              // TODO: Generic messages for Marlin
+    GET_TEXT_F(MSG_PROGRESS_OK),              // @@TODO Generic messages for Marlin
     GET_TEXT_F(MSG_PROGRESS_ENGAGE_IDLER),    // reused below
     GET_TEXT_F(MSG_PROGRESS_DISENGAGE_IDLER), // reused below
     GET_TEXT_F(MSG_PROGRESS_UNLOAD_FINDA),
diff --git a/Marlin/src/feature/mmu3/mmu3_protocol_logic.cpp b/Marlin/src/feature/mmu3/mmu3_protocol_logic.cpp
@@ -232,7 +232,7 @@ namespace MMU3 {
     #endif
     uint8_t len = Protocol::EncodeRequest(rq, txbuff);
     #if defined(__AVR__) || defined(TARGET_LPC1768)
-      // TODO: I'm not sure if this is the correct approach with AVR
+      // @@TODO I'm not sure if this is the correct approach with AVR
       for ( uint8_t i = 0; i < len; i++) {
         MMU_SERIAL.write(txbuff[i]);
       }
@@ -252,7 +252,7 @@ namespace MMU3 {
     uint8_t len = Protocol::EncodeWriteRequest(rq.value, rq.value2, txbuff);
 
     #if defined(__AVR__) || defined(TARGET_LPC1768)
-      // TODO: I'm not sure if this is the correct approach with AVR
+      // @@TODO I'm not sure if this is the correct approach with AVR
       for ( uint8_t i = 0; i < len; i++) {
         MMU_SERIAL.write(txbuff[i]);
       }
diff --git a/Marlin/src/feature/mmu3/mmu3_reporting.cpp b/Marlin/src/feature/mmu3/mmu3_reporting.cpp
@@ -311,7 +311,7 @@ namespace MMU3 {
 
       START_MENU();
       #ifndef __AVR__
-        // TODO: I couldn't make this work on AVR
+        /// TODO: I couldn't make this work on AVR
         STATIC_ITEM_F(PrusaErrorTitle(ei), SS_DEFAULT | SS_INVERT);
 
         // Write the help page and error code
diff --git a/Marlin/src/feature/tmc_util.cpp b/Marlin/src/feature/tmc_util.cpp
@@ -1176,7 +1176,7 @@
   bool tmc_enable_stallguard(TMC2240Stepper &st) {
     const bool stealthchop_was_enabled = st.en_pwm_mode();
 
-    // TODO: Use StallGuard4 when stealthChop is enabled
+    /// TODO: Use StallGuard4 when stealthChop is enabled
     //       and leave stealthChop state unchanged.
 
     st.TCOOLTHRS(0xFFFFF);
@@ -1192,7 +1192,7 @@
   }
 
   bool tmc_enable_stallguard(TMC2660Stepper) {
-    // TODO
+    /// TODO:
     return false;
   }
   void tmc_disable_stallguard(TMC2660Stepper, const bool) { }
diff --git a/Marlin/src/lcd/extui/dgus/mks/DGUSScreenHandler.cpp b/Marlin/src/lcd/extui/dgus/mks/DGUSScreenHandler.cpp
@@ -773,7 +773,7 @@ void DGUSScreenHandler::handleManualMove(DGUS_VP_Variable &var, void *val_ptr) {
   const bool old_relative_mode = relative_mode;
   if (!relative_mode) queue.enqueue_now(F("G91"));
 
-  // TODO: Use MString / TS() ...
+  /// TODO: Use MString / TS() ...
 
   char buf[32]; // G1 X9999.99 F12345
   char sign[] = "\0";
@@ -999,7 +999,8 @@ void DGUSScreenHandlerMKS::filamentLoadUnload(DGUS_VP_Variable &var, void *val_p
   #endif
 
   if (swap_tool) {
-    char buf[30]; // TODO: Use MString / TS()
+    char buf[30];
+    /// TODO: Use MString / TS()
     snprintf_P(buf, 30,
       #if ANY(HAS_MULTI_HOTEND, SINGLENOZZLE)
         PSTR("M1002T%cE%dF%d"), char('0' + swap_tool - 1)
@@ -1019,7 +1020,8 @@ void DGUSScreenHandlerMKS::filamentLoadUnload(DGUS_VP_Variable &var, void *val_p
 void GcodeSuite::M1002() {
   #if ANY(HAS_MULTI_HOTEND, SINGLENOZZLE)
   {
-    char buf[3]; // TODO: Use MString / TS()
+    char buf[3];
+    /// TODO: Use MString / TS()
     sprintf_P(buf, PSTR("T%c"), char('0' + parser.intval('T')));
     process_subcommands_now(buf);
   }
@@ -1029,7 +1031,8 @@ void GcodeSuite::M1002() {
   set_e_relative(); // M83
 
   {
-    char buf[20]; // TODO: Use MString / TS()
+    char buf[20];
+    /// TODO: Use MString / TS()
     snprintf_P(buf, 20, PSTR("G1E%dF%d"), parser.intval('E'), parser.intval('F'));
     process_subcommands_now(buf);
   }
diff --git a/Marlin/src/lcd/sovol_rts/sovol_rts.cpp b/Marlin/src/lcd/sovol_rts/sovol_rts.cpp
@@ -1056,7 +1056,8 @@ void RTS::handleData() {
     case FilamentCheckKey:
       switch (recdat.data[0]) {
         case 1:
-          TERN_(CHECKFILAMENT, gotoPage(runout.filament_ran_out ? ID_NoFilament_L : ID_Load_L, runout.filament_ran_out ? ID_NoFilament_D : ID_Load_D)); // TODO: add page enum
+          TERN_(CHECKFILAMENT, gotoPage(runout.filament_ran_out ? ID_NoFilament_L : ID_Load_L, runout.filament_ran_out ? ID_NoFilament_D : ID_Load_D));
+          /// TODO: add page enum
           break;
         case 2:
           gotoPage(ID_Settings_L, ID_Settings_D);
@@ -1585,7 +1586,7 @@ void RTS::onIdle() {
 
   next_rts_update_ms = ms + RTS_UPDATE_INTERVAL + update_time_value;
 
-  // TODO: optimize the following
+  /// TODO: optimize the following
   if (print_job_timer.duration() != 0) {
     duration_t elapsed = print_job_timer.duration();
     static uint8_t last_cardpercentValue = 100;
diff --git a/Marlin/src/lcd/tft/touch.cpp b/Marlin/src/lcd/tft/touch.cpp
@@ -134,7 +134,7 @@ void Touch::idle() {
       else {
         // Initiate a touch on the first control containing the touch position
         // If this is a button the touch initiates the action on the button.
-        // TODO: Apply standard UI practice for Tap events:
+        /// TODO: Apply standard UI practice for Tap events:
         //  - Take a short press-and-release as a Tap.
         //  - If more taps occur before "tap detect time" elapses, increment taps counter.
         //  - When "tap detect time" elapses activate the button, sending the number of taps.
diff --git a/Marlin/src/module/stepper.h b/Marlin/src/module/stepper.h
@@ -697,7 +697,7 @@ class Stepper {
     static void mark_axis_enabled(const AxisEnum axis E_OPTARG(const uint8_t eindex=0)) {
       SBI(axis_enabled.bits, INDEX_OF_AXIS(axis, eindex));
       TERN_(HAS_Z_AXIS, if (axis == Z_AXIS) z_min_trusted = true);
-      // TODO: DELTA should have "Z" state affect all (ABC) motors and treat "XY" on/off as meaningless
+      /// TODO: DELTA should have "Z" state affect all (ABC) motors and treat "XY" on/off as meaningless
     }
     static void mark_axis_disabled(const AxisEnum axis E_OPTARG(const uint8_t eindex=0)) {
       CBI(axis_enabled.bits, INDEX_OF_AXIS(axis, eindex));
@@ -707,7 +707,7 @@ class Stepper {
           current_position.z = 0;
         }
       #endif
-      // TODO: DELTA should have "Z" state affect all (ABC) motors and treat "XY" on/off as meaningless
+      /// TODO: DELTA should have "Z" state affect all (ABC) motors and treat "XY" on/off as meaningless
     }
     static bool can_axis_disable(const AxisEnum axis E_OPTARG(const uint8_t eindex=0)) {
       return !any_enable_overlap() || !(axis_enabled.bits & enable_overlap[INDEX_OF_AXIS(axis, eindex)]);
diff --git a/Marlin/src/pins/samd/pins_MINITRONICS20.h b/Marlin/src/pins/samd/pins_MINITRONICS20.h
@@ -108,7 +108,7 @@
 
 // This board have the option to use an extra TMC2209 stepper, one of the use could be as a second extruder.
 #if EXTRUDERS < 2
-  // TODO: Correct here that when we have two extruders (or whatever), use the extra endstops. i.e., The max, there is no Z2_endstop.
+  /// TODO: Correct here that when we have two extruders (or whatever), use the extra endstops. i.e., The max, there is no Z2_endstop.
   #if NUM_Z_STEPPERS > 1
     #define Z2_STOP_PIN                       14
   #endif
diff --git a/Marlin/src/pins/stm32f1/pins_MKS_ROBIN_E3_common.h b/Marlin/src/pins/stm32f1/pins_MKS_ROBIN_E3_common.h
@@ -258,7 +258,7 @@
 #define SD_DETECT_PIN                EXP2_07_PIN
 #define NO_SD_HOST_DRIVE
 
-// TODO: This is the only way to set SPI for SD on STM32 (for now)
+/// TODO: This is the only way to set SPI for SD on STM32 (for now)
 #define ENABLE_SPI2
 #define SD_SCK_PIN                   EXP2_02_PIN
 #define SD_MISO_PIN                  EXP2_01_PIN
diff --git a/Marlin/src/pins/stm32f1/pins_ZM3E4_V1_0.h b/Marlin/src/pins/stm32f1/pins_ZM3E4_V1_0.h
@@ -190,7 +190,7 @@
   #define Z2_DIR_PIN                        PD0
 #endif
 
-// TODO: Use different pin names for auto-remapping
+/// TODO: Use different pin names for auto-remapping
 #ifdef OPTION_Z2_ENDSTOP
   #define Z2_MIN_PIN                        PD1
   #define Z2_MAX_PIN                        PB12
diff --git a/Marlin/src/pins/stm32f1/pins_ZM3E4_V2_0.h b/Marlin/src/pins/stm32f1/pins_ZM3E4_V2_0.h
@@ -156,7 +156,7 @@
 #define Y_MAX_PIN                           PB14
 #define Z_MAX_PIN                           PB13
 
-// TODO: Use different pin names for auto-remapping
+/// TODO: Use different pin names for auto-remapping
 #ifdef OPTION_Z2_ENDSTOP
   #define Z2_MIN_PIN                        PD1
   #define Z2_MAX_PIN                        PB12
diff --git a/Marlin/src/sd/disk_io_driver.h b/Marlin/src/sd/disk_io_driver.h
@@ -33,7 +33,7 @@ class DiskIODriver {
 public:
   /**
    * Initialize an SD flash memory card with default clock rate and chip
-   * select pin.  See sd2Card::init(uint8_t sckRateID, uint8_t chipSelectPin).
+   * select pin. See sd2Card::init(uint8_t sckRateID, uint8_t chipSelectPin).
    *
    * \return true for success or false for failure.
    */

Original file line number	Diff line number	Diff line change
`@@ -300,7 +300,7 @@ void MarlinHAL::set_pwm_duty(const pin_t pin, const uint16_t value, const uint16`
`300`	`300`	`}`
`301`	`301`
`302`	`302`	`void MarlinHAL::set_pwm_frequency(const pin_t pin, const uint16_t f_desired) {`
`303`		`- // TODO set_pwm_frequency is not implemented yet`
	`303`	`+ /// TODO: set_pwm_frequency is not implemented yet`
`304`	`304`	`panic("set_pwm_frequency is not implemented yet\n");`
`305`	`305`	`}`
`306`	`306`
Original file line number	Diff line number	Diff line change
`@@ -166,7 +166,7 @@ void core_hook_sysclock_init() {`
`166`	`166`	`sysclock_configure_hrc();`
`167`	`167`
`168`	`168`	`// HRC could have been configured by ICG to 20 MHz`
`169`		`- // TODO: handle gracefully if HRC is not 16 MHz`
	`169`	`+ /// TODO: handle gracefully if HRC is not 16 MHz`
`170`	`170`	`if (1UL != (HRC_FREQ_MON() & 1UL)) {`
`171`	`171`	`panic("HRC is not 16 MHz");`
`172`	`172`	`}`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,8 @@ bool getValidPinMode(const int8_t pin) { // 1: output, 0: input`
`66`	`66`
`67`	`67`	`void printPinPWM(const int32_t pin) {`
`68`	`68`	`if (pwm_status(pin)) {`
`69`		`- //uint32_t chan = g_APinDescription[pin].ulPWMChannel TODO when fast pwm is operative;`
	`69`	`+ //uint32_t chan = g_APinDescription[pin].ulPWMChannel`
	`70`	`+ /// TODO: when fast pwm is operative;`
`70`	`71`	`//SERIAL_ECHOPGM("PWM = ", duty);`
`71`	`72`	`}`
`72`	`73`	`}`