📝 Update comments in bedleveling/probe - feature/gcode - Githubissues

MarlinFirmware / Marlin

Marlin is an optimized firmware for RepRap 3D printers based on the Arduino platform. Many commercial 3D printers come with Marlin installed. Check with your vendor if you need source code for your specific machine.

https://marlinfw.org

GNU General Public License v3.0

15.94k stars 19.08k forks source link

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

Open classicrocker883 opened 2 weeks ago

classicrocker883 commented 2 weeks ago

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 commented 2 weeks ago

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.