-
Notifications
You must be signed in to change notification settings - Fork 43
Review/add the API doc (geo folder - part 1)
#1191
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
Conversation
4c27706 to
94aa471
Compare
Codecov Report
@@ Coverage Diff @@
## master #1191 +/- ##
======================================
Coverage 84.7% 84.7%
======================================
Files 358 358
Lines 12252 12253 +1
======================================
+ Hits 10377 10378 +1
Misses 1875 1875
Continue to review full report at Codecov.
|
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.
| ///@brief Creates a `GeoCoordinates` instance with invalid coordinates. | |
| /// Creates a `GeoCoordinates` instance with invalid coordinates. |
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.
| * @note Use `normalized()` to put a coordinate in a valid range. | |
| * @note Use `Normalized()` to put a coordinate in a valid range. |
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.
Same.
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.
Same.
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.
| * @brief Creates a `GeoRectangle` insatnce. | |
| * @brief Creates a `GeoRectangle` instance. |
In olp-cpp-sdk-core/include/olp/core/geo/coordinates&projection, review and modify the existing documentation and add missing descriptions so that we have fewer errors when building the API ref. Relates-To: OLPEDGE-1444 Signed-off-by: Halyna Dumych <ext-halyna.dumych@here.com>
94aa471 to
b5f2e31
Compare
In olp-cpp-sdk-core/include/olp/core/geo/coordinates&projection,
review and modify the existing documentation and add missing
descriptions so that we have fewer errors when building the API ref.
Relates-To: OLPEDGE-1444
Signed-off-by: Halyna Dumych ext-halyna.dumych@here.com