-
-
Notifications
You must be signed in to change notification settings - Fork 19.3k
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
thinkyhead
merged 14 commits into
MarlinFirmware:bugfix-2.1.x
from
classicrocker883:bugfix-2.1.x-April9
May 20, 2024
Merged
📝 Update comments in bedleveling/probe - feature/gcode #27034
thinkyhead
merged 14 commits into
MarlinFirmware:bugfix-2.1.x
from
classicrocker883:bugfix-2.1.x-April9
May 20, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sjasonsmith
reviewed
Apr 30, 2024
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
changed the title
📝Update comments in bedleveling/probe - feature/gcode
📝 Update comments in bedleveling/probe - feature/gcode
Apr 30, 2024
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
force-pushed
the
bugfix-2.1.x-April9
branch
2 times, most recently
from
May 20, 2024 04:57
5efa744
to
caf07d9
Compare
thinkyhead
force-pushed
the
bugfix-2.1.x-April9
branch
from
May 20, 2024 04:59
caf07d9
to
5db6d86
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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
UBL G29 doesnt have anything that reads for 'Z' so not sure what this is about.