Marlin icon indicating copy to clipboard operation
Marlin copied to clipboard

📝 Update comments in bedleveling/probe - feature/gcode

Open classicrocker883 opened this issue 1 year ago • 1 comments

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.

classicrocker883 avatar Apr 29 '24 15:04 classicrocker883

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.

sjasonsmith avatar Apr 30 '24 04:04 sjasonsmith

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 avatar May 20 '24 04:05 thinkyhead