Line detector documentation #16
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
sharwell
reviewed
May 24, 2021
| bool notifyOccupancy(int frameNo, bool occupancy); | ||
|
|
||
| //TODO(isaach): Should be a property. |
There was a problem hiding this comment.
💡 If you do have a TODO with this form, consider matching the username form you use on GitHub
Suggested change
| //TODO(isaach): Should be a property. | |
| //TODO(iharwell): Should be a property. |
| /// <summary> | ||
| /// The first point of the line. | ||
| /// </summary> | ||
| public Point p1 { get; set; } |
There was a problem hiding this comment.
❔ While the fields were not marked readonly, it's not clear that was intentional. Is it possible to make these properties readonly?
Suggested change
| public Point p1 { get; set; } | |
| public Point p1 { get; } |
Comment on lines
33
to
36
| /// <summary> | ||
| /// The overlap threshold used to determine occupancy. | ||
| /// </summary> | ||
| public double overlapFractionThreshold { get; set; } = DEFAULT_OCCUPANCY_THRESHOLD; |
There was a problem hiding this comment.
💡 Consider removing this default value assignment, and updating the constructor to chain like this:
: this(a, b, c, d, DEFAULT_OCCUPANCY_THRESHOLD)Minor changes to the documentation comments to ensure everything works as expected. Minor refactoring removed to place in a separate branch.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Nothing too involved here. I went through and added XML documentation to nearly everything in the LineDetector project. This should make it a bit easier to work on moving forward.
There's a little bit left to do, though. In particular, some classes don't have class-level documentation yet.
There are also a couple of TODOs in the comments regarding some methods that should probably be replaced with properties, some interface members that could use some reorganizing, etc.