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
16.34k stars 19.25k forks source link

Update planner #27497

Closed classicrocker883 closed 3 weeks ago

classicrocker883 commented 1 month ago

Description

planner.h / planner.cpp

Clearly describe the submitted changes with lots of details. Include images where helpful. Initial reviewers may not be familiar with the subject, so be as thorough as possible. You can use MarkDown syntax to improve readability with bullet lists, code blocks, and so on. PREVIEW and fix up formatting before submitting.

-->

Requirements

Benefits

Configurations

Related Issues

thinkyhead commented 3 weeks ago

We don't need to enforce Doxygen style comments in Marlin because we don't generate documentation or publish APIs for, e.g., the Planner class. Thus for comments on Marlin-specific methods and functions let's make it a general principle going forward to try to stick to human-readable formatting. Also, Doxygen formatting is less necessary from 2024 onward because we have LLMs and other tools that can derive the same information without the need for strict formatting.