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

📝 Update comments in bedleveling/probe - feature/gcode #27034

Merged

Conversation

classicrocker883
Copy link
Contributor

Description

Most changes are to feature/bedlevel/, gcode/bedlevel/, and gcode/probe/

Major changes to the comment blocks having details about Gcode commands. Updated with doxygen commands with better understand and readability.

Updates and changes including but not limited to:

  • Spacing
  • Remove periods at end and capitialize first word in sentence (like rest of code)
  • Update/add doxygen comment commands
  • Update/improve Gcode descriptions. Better readability, ect...

A couple files had some outliers that needed fixed, like **/ instead of */

Requirements

Benefits

Improves readability, Updates descriptions/details/usage of the gcodes while adding doxygen commands.

Configurations

Related Issues

in feature/bedlevel/ubl/ubl_G29.cpp (and also in MarlinDocumentation) one thing stood out that is wrong

G29 Z C uses the Current location (instead of bed center or nearest edge).

UBL G29 doesnt have anything that reads for 'Z' so not sure what this is about.

@sjasonsmith
Copy link
Contributor

I reverted the code change that was mixed into this. The rest will have to wait for @thinkyhead to make the call on whether he wants these comment changes or not.

@thisiskeithb thisiskeithb changed the title 📝Update comments in bedleveling/probe - feature/gcode 📝 Update comments in bedleveling/probe - feature/gcode Apr 30, 2024
@thinkyhead
Copy link
Member

The use of @brief, @description, @param, etc. in the descriptions of G-code parameters is improper. Those changes will all need to be reverted.

@thinkyhead thinkyhead force-pushed the bugfix-2.1.x-April9 branch 2 times, most recently from 5efa744 to caf07d9 Compare May 20, 2024 04:57
@thinkyhead thinkyhead force-pushed the bugfix-2.1.x-April9 branch from caf07d9 to 5db6d86 Compare May 20, 2024 04:59
@thinkyhead thinkyhead merged commit 6c018eb into MarlinFirmware:bugfix-2.1.x May 20, 2024
62 checks passed
@classicrocker883 classicrocker883 deleted the bugfix-2.1.x-April9 branch May 22, 2024 14:28
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.

4 participants