Marlin icon indicating copy to clipboard operation
Marlin copied to clipboard

Major cleanup of comments/spacing

Open classicrocker883 opened this issue 1 year ago • 0 comments

Description

Most important take away from this:

  • runout.h spacing in one section need fixing
  • src/feature files
  • src/module files
  • HAL/DUE/usb files
  • sd/usb_flashdrive files

The majority of changes to src/[module+feature] adds missing header to these files. example:

/**
 * feature/ammeter.h
 */

as well as:

  • Tweak spacing on comments
  • Capitalize where needed
  • Add parenthesis around units (i.e. (mm))

Other Major changes

Spacing and Cleanup HAL/DUE/usb + sd/usb_flashdrive files
for example:

  • /* => /**
  • #endif /* [insert] */ => #endif // [insert]
  • TO-DO/to-do => TODO:

Benefits

Updates the files to be similar like the rest. Spacing. Readability, and update some sentences make better sense.

Configurations

Related Issues

other files in src/module could use header with their filename added to them.

classicrocker883 avatar Jul 02 '24 06:07 classicrocker883