Skip to content
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

Merged
merged 5 commits into from
Dec 28, 2017
Merged

Added documentation #1028

merged 5 commits into from
Dec 28, 2017

Conversation

Agent-8
Copy link
Contributor

@Agent-8 Agent-8 commented Dec 27, 2017

files edited: LatLng.java, SettingsActivity.java, CompatTextView.java, HtmlTextView.java, OverlayDialog.java

code left unchanged

Copy link
Member

@nicolas-raoul nicolas-raoul left a 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
Copy link
Member

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
*/
Copy link
Member

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
Copy link
Member

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
*/
Copy link
Member

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
Copy link
Member

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
Copy link
Member

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.

@commons-app commons-app deleted a comment Dec 27, 2017
@codecov-io
Copy link

codecov-io commented Dec 27, 2017

Codecov Report

Merging #1028 into master will not change coverage.
The diff coverage is 30.92%.

Impacted file tree graph

@@          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
Impacted Files Coverage Δ
...a/fr/free/nrw/commons/ui/widget/OverlayDialog.java 0% <ø> (ø) ⬆️
.../fr/free/nrw/commons/ui/widget/CompatTextView.java 0% <0%> (ø) ⬆️
...va/fr/free/nrw/commons/ui/widget/HtmlTextView.java 0% <0%> (ø) ⬆️
...main/java/fr/free/nrw/commons/location/LatLng.java 52.77% <52.77%> (ø) ⬆️
...fr/free/nrw/commons/settings/SettingsActivity.java 61.11% <61.11%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f7d4914...e72819f. Read the comment docs.

@nicolas-raoul nicolas-raoul merged commit 863c43f into commons-app:master Dec 28, 2017
@nicolas-raoul
Copy link
Member

Please ask for review so that I can approve the task, thanks! :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants