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 planner #27497

Merged

Conversation

classicrocker883
Copy link
Contributor

@classicrocker883 classicrocker883 commented Oct 26, 2024

Description

planner.h / planner.cpp

  • Update doxygen comments, spacing
  • Remove redundant public/private
    • ie: friend void do_homing_move is out of place
  • Define unlike variables excplitly
-  uint32_t max_acceleration_mm_per_s2[DISTINCT_AXES],
-           min_segment_time_us; 

+  uint32_t max_acceleration_mm_per_s2[DISTINCT_AXES];
+  uint32_t min_segment_time_us;

Requirements

Benefits

  • Use correct doxygen syntax
  • Improve details of functions in comments, readability
  • By defining variables explicitly, reduce errors when reading from EEPROM

Configurations

Related Issues

@thinkyhead
Copy link
Member

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.

@thinkyhead thinkyhead merged commit dff2104 into MarlinFirmware:bugfix-2.1.x Oct 29, 2024
63 checks passed
bsdnomad pushed a commit to bsdnomad/Marlin that referenced this pull request Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants