Review documentation (issue #97) #162
Merged
Conversation
This file contains hidden or 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
Review doxygen links. Review documentation layout in proto (80 chars). Review doxgen commands. Remove typos Rename DetectionHeader --> SensorDetectionHeader Review TrafficSignTyps and add some traffic signs. Add references to traffic sign images. Generalize traffic signs (30km/h zone --> speed limit zone & value & value_unit) Rename repeated field names (plural or list as suffix). Add units to message field documentation.
Contributor
Author
|
@CarloVanDriestenBMW See all "important" changes in bold. |
carsten-kuebler
added
the
Documentation
ghost
suggested changes
Mar 20, 2018
ghost
left a comment
ghost
left a comment
There was a problem hiding this comment.
Dokumentaion has references to old name "DetectionHeader"
osi_common.proto
Outdated
| // Azimuth and elevation are defined as the rotations that would have to be | ||
| // applied to the local frame (e.g sensor frame definition in | ||
| // \c OSI:DetectionHeader) to make its x-axis point towards the referenced point | ||
| // \c DetectionHeader) to make its x-axis point towards the referenced point |
Contributor
Author
There was a problem hiding this comment.
@CarloVanDriestenBMW I changed all DetectionHeader to SensorDetecionHeader.
ghost
added this to the
Typos removed. Add plural s for repeated message fields Add \c in documentation.
ghost
merged commit 
This pull request was closed.
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.
This PR addresses issue #97.
Review doxygen links.
Review documentation layout in proto (80 chars).
Review doxgen commands.
Remove typos
Rename DetectionHeader --> SensorDetectionHeader
Review TrafficSignTyps and add some traffic signs.
Add references to traffic sign images.
Generalize traffic signs (30km/h zone --> speed limit zone & value & value_unit)
Rename repeated field names (plural or list as suffix).
Add units to message field documentation.