-
Notifications
You must be signed in to change notification settings - Fork 4
Typos and docs #367
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
Typos and docs #367
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR focuses on code cleanup and documentation improvements. It removes extraneous whitespace, adds missing documentation comments for public methods, and refactors simple getter methods to be inline in the header file.
- Removed unnecessary blank lines and whitespace
- Added comprehensive documentation (doxygen-style) for previously undocumented methods
- Converted simple getter methods from out-of-line to inline implementations
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/dsf/utility/queue.hpp | Removed extraneous blank line at the beginning of the file |
| src/dsf/base/Node.hpp | Added documentation for addIngoingEdge and addOutgoingEdge methods |
| src/dsf/base/Edge.hpp | Added documentation for setter methods and inlined simple getter methods |
| src/dsf/base/Edge.cpp | Removed method implementations that were moved to inline in the header |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| void resetId(Id newId); | ||
| /// @brief Set the edge's geometry | ||
| /// @param geometry dsf::geometry::PolyLine The edge's geometry, a vector of pairs of doubles representing the coordinates of the edge's geometry |
Copilot
AI
Nov 14, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation format is inconsistent. The parameter type 'dsf::geometry::PolyLine' should not be included in the @param description - it should only contain the parameter name followed by the description. The type is already declared in the function signature.
| /// @param geometry dsf::geometry::PolyLine The edge's geometry, a vector of pairs of doubles representing the coordinates of the edge's geometry | |
| /// @param geometry The edge's geometry, a vector of pairs of doubles representing the coordinates of the edge's geometry |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #367 +/- ##
==========================================
+ Coverage 83.47% 83.49% +0.01%
==========================================
Files 51 51
Lines 5090 5089 -1
Branches 587 587
==========================================
Hits 4249 4249
+ Misses 829 828 -1
Partials 12 12
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
No description provided.