-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Added documentation #1028
Added documentation #1028
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.
Great!
Just a few minor things, could you please modify them?
Thanks!
import android.support.annotation.NonNull; | ||
|
||
/** | ||
* the latitude and longitude of the user |
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.
-> "A latitude and longitude point with accuracy information"
It is often the lat/long of a picture, not where the user currently is.
* | ||
* @param latitude double value | ||
* @param longitude double value | ||
*/ |
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.
How about some info about the accuracy format, with one or two examples? Thanks!
|
||
/** | ||
* checks for equality of two LatLng objects | ||
* @param o the second LatLng object |
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.
Good!
|
||
/** | ||
* a formatted dialog fragment | ||
*/ |
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.
Could you please add "This class is used by NearbyInfoDialog"? Thanks!
} | ||
|
||
/** | ||
* allows subclasses to initialize themselves if needed |
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.
I think the goal of this method is not really to allows subclasses to initialize themselves (they could do it without this method).
Please change to "When the view is created, set the dialog layout to full screen". Thanks!
window.setAttributes(wlp); | ||
} | ||
|
||
@NonNull |
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.
How about a generic javadoc comment here? You can take it from the overridden method.
Codecov Report
@@ Coverage Diff @@
## master #1028 +/- ##
======================================
Coverage 3.71% 3.71%
======================================
Files 104 104
Lines 5143 5143
Branches 489 489
======================================
Hits 191 191
Misses 4939 4939
Partials 13 13
Continue to review full report at Codecov.
|
Please ask for review so that I can approve the task, thanks! :-) |
files edited: LatLng.java, SettingsActivity.java, CompatTextView.java, HtmlTextView.java, OverlayDialog.java
code left unchanged