Skip to content

Commit e904e57

Browse files
Update - Use NOTE:
1 parent 9c6872d commit e904e57

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+58
-57
lines changed

Marlin/Configuration_adv.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4377,7 +4377,7 @@
43774377
/**
43784378
* Instant freeze / unfreeze functionality
43794379
* Potentially useful for rapid stop that allows being resumed. Halts stepper movement.
4380-
* Note this does NOT pause spindles, lasers, fans, heaters or any other auxiliary device.
4380+
* NOTE: This does NOT pause spindles, lasers, fans, heaters or any other auxiliary device.
43814381
* @section interface
43824382
*/
43834383
//#define FREEZE_FEATURE

Marlin/src/HAL/HC32/HAL.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
/**
2424
* HAL for HC32F460 based boards
2525
*
26-
* Note: MarlinHAL class is in MarlinHAL.h/cpp
26+
* NOTE: MarlinHAL class is in MarlinHAL.h/cpp
2727
*/
2828

2929
#define CPU_32_BIT

Marlin/src/HAL/HC32/sysclock.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
*
3333
* The peripheral clocks are the result of integer division of F_SYSTEM_CLOCK.
3434
* Their target frequencies are defined here, and the required division factors are calculated automatically.
35-
* Note that the division factor must be a power of 2 between 1 and 64.
35+
* NOTE: The division factor must be a power of 2 between 1 and 64.
3636
* If the target frequency is not achievable, a compile-time error will be generated.
3737
*
3838
* Additionally, there are interdependencies between the peripheral clocks, which are described in

Marlin/src/feature/bedlevel/ubl/ubl_G29.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@
280280
* W What? Display valuable UBL data.
281281
*
282282
*
283-
* Release Notes:
283+
* NOTES:
284284
* You MUST do M502, M500 to initialize the storage. Failure to do this will cause all
285285
* kinds of problems. Enabling EEPROM Storage is required.
286286
*

Marlin/src/feature/mmu3/mmu3_reporting.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ namespace MMU3 {
115115
uint8_t lcd_cursor_col;
116116
// The total length is twice delta_mm. Divide that length by number of pixels
117117
// available to get length per pixel.
118-
// Note: Below is the reciprocal of (2 * delta_mm) / LCD_WIDTH [mm/pixel]
118+
/// NOTE: Below is the reciprocal of (2 * delta_mm) / LCD_WIDTH [mm/pixel]
119119
float pixel_per_mm;
120120
};
121121

@@ -135,7 +135,7 @@ namespace MMU3 {
135135
//void DisableMMUInSettings();
136136

137137
// Increments EEPROM cell - number of failed loads into the nozzle
138-
// Note: technically, this is not an MMU error but an error of the printer.
138+
/// NOTE: Technically, this is not an MMU error but an error of the printer.
139139
void IncrementLoadFails();
140140

141141
// Increments EEPROM cell - number of MMU errors

Marlin/src/lcd/e3v2/common/dwin_api.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ void DWIN_Frame_Clear(const uint16_t color) {
153153
// map_columns: columns in theh point map. each column is a byte in the map and contains 8 points
154154
// map_rows: rows in the point map
155155
// map: point bitmap. 2D array of points, 1 bit per point
156-
// Note: somewhat similar to U8G's drawBitmap() function, see https://github.com/olikraus/u8glib/wiki/userreference#drawbitmap
156+
/// NOTE: Somewhat similar to U8G's drawBitmap() function, see https://github.com/olikraus/u8glib/wiki/userreference#drawbitmap
157157
void DWIN_Draw_PointMap(
158158
const uint16_t color,
159159
const uint8_t point_width, const uint8_t point_height,

Marlin/src/lcd/e3v2/common/encoder.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ EncoderState encoderReceiveAnalyze() {
110110

111111
// Encoder rate multiplier
112112
if (encoderRate.enabled) {
113-
// Note that the rate is always calculated between two passes through the
113+
/// NOTE: The rate is always calculated between two passes through the
114114
// loop and that the abs of the temp_diff value is tracked.
115115
const float encoderStepRate = ((float(abs_diff) / float(ENCODER_PULSES_PER_STEP)) * 1000.0f) / float(ms - encoderRate.lastEncoderTime);
116116
encoderRate.lastEncoderTime = ms;

Marlin/src/lcd/extui/mks_ui/uthash.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -884,7 +884,7 @@ do {
884884

885885

886886
/* This is an adaptation of Simon Tatham's O(n log(n)) mergesort */
887-
/* Note that HASH_SORT assumes the hash handle name to be hh.
887+
/** NOTE: HASH_SORT assumes the hash handle name to be hh.
888888
* HASH_SRT was added to allow the hash handle name to be passed in. */
889889
#define HASH_SORT(head,cmpfcn) HASH_SRT(hh,head,cmpfcn)
890890
#define HASH_SRT(hh,head,cmpfcn) \

Marlin/src/lcd/marlinui.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1083,7 +1083,7 @@ void MarlinUI::init() {
10831083
#if ALL(HAS_MARLINUI_MENU, ENCODER_RATE_MULTIPLIER)
10841084

10851085
if (encoder_multiplier_enabled) {
1086-
// Note that the rate is always calculated between two passes through the
1086+
/// NOTE: That the rate is always calculated between two passes through the
10871087
// loop and that the abs of the encoderDiff value is tracked.
10881088
static millis_t encoder_mult_prev_ms = 0;
10891089
const float encoderStepRate = ((float(abs_diff) / float(epps)) * 1000.0f) / float(ms - encoder_mult_prev_ms);

Marlin/src/module/ft_motion.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ void FTMotion::discard_planner_block_protected() {
232232
planner.release_current_block(); // FTM uses release_current_block() instead of discard_current_block(),
233233
// as in block_phase_isr(). This change is to avoid invoking axis_did_move.reset().
234234
// current_block = nullptr is added to replicate discard without axis_did_move reset.
235-
// Note invoking axis_did_move.reset() causes no issue since FTM's stepper refreshes
235+
/// NOTE: Invoking axis_did_move.reset() causes no issue since FTM's stepper refreshes
236236
// its values every ISR.
237237
}
238238
}
@@ -504,7 +504,7 @@ stepper_plan_t FTMotion::calc_stepper_plan(xyze_float_t traj_coords) {
504504
/* 3) Set per-iteration advance dividend Q0.32 */ \
505505
uint64_t delta_uq32_32 = ABS(delta_q32_32); \
506506
/* dividend = delta_q32_32 / ITERATIONS_PER_TRAJ, but avoiding division and an intermediate int128 */ \
507-
/* Note the integer part would overflow if there is eq or more than 1 steps per isr */ \
507+
/** NOTE: The integer part would overflow if there is eq or more than 1 steps per isr */ \
508508
uint32_t integer_part = (delta_uq32_32 >> 32) * ITERATIONS_PER_TRAJ_INV_uq0_32; \
509509
uint32_t fractional_part = ((delta_uq32_32 & UINT32_MAX) * ITERATIONS_PER_TRAJ_INV_uq0_32) >> 32; \
510510
stepper_plan.advance_dividend_q0_32.A = integer_part + fractional_part; \

0 commit comments

Comments
 (0)