Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Major cleanup of comments/spacing #27231

Open
wants to merge 10 commits into
base: bugfix-2.1.x
Choose a base branch
from

Conversation

classicrocker883
Copy link
Contributor

@classicrocker883 classicrocker883 commented Jul 2, 2024

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 classicrocker883 changed the title Update src/feature Update src/feature files Jul 2, 2024
@classicrocker883 classicrocker883 changed the title Update src/feature files Update src/feature + src/module files Jul 2, 2024
@classicrocker883 classicrocker883 changed the title Update src/feature + src/module files Major cleanup of comments/spacing Jul 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants