Added JavaDoc comments to few methods and classes #1025
Conversation
| public static RefWatcher getRefWatcher(Context context) { | ||
| CommonsApplication application = (CommonsApplication) context.getApplicationContext(); | ||
| return application.refWatcher; | ||
| } |
There was a problem hiding this comment.
Any particular reason to have moved this method?
There was a problem hiding this comment.
Auto code clean up may have been the cause of it
There was a problem hiding this comment.
Could you please move it back? It was intentionally just below the refWatcher declaration.
You can use the page https://github.com/commons-app/apps-android-commons/pull/1025/files to see exactly what you changed :-) Thanks!
| import java.util.Map; | ||
|
|
||
| /** | ||
| * Represents LicenseList |
There was a problem hiding this comment.
A list of licenses, actually :-)
Would you mind correcting?
There was a problem hiding this comment.
No problem I will change it
| } | ||
|
|
||
| /** | ||
| * Modifies tag of media |
| import java.util.Map; | ||
|
|
||
| /** | ||
| * Represents a list of |
| } | ||
|
|
||
| /** | ||
| * Encodes given URL in UTF-8 format |
There was a problem hiding this comment.
Tricky, please write "URLEncode an URL and make its first character uppercase".
| /** | ||
| * Encodes given URL in UTF-8 format | ||
| * @param url Unformatted URL | ||
| * @return Formatted URL |
| * | ||
| * @param context Activity context | ||
| */ | ||
| public static void startYourself(Context context) { |
There was a problem hiding this comment.
Please move this method back where it was too, thanks!
| } | ||
|
|
||
| /** | ||
| * Interface used create on clicked callback(s). |
There was a problem hiding this comment.
I am actually not sure what this method does, so can you please remove the Javadoc? Thanks!
There was a problem hiding this comment.
Are mentioning that destroy item comment or the one for interface
There was a problem hiding this comment.
You can remove the Javadoc of "public interface Callback {", thanks! :-)
| */ | ||
| public String getName() { | ||
| return name; | ||
| } |
There was a problem hiding this comment.
Please put all of these methods back where they were, thanks!
| + ");"; | ||
|
|
||
| /** | ||
| * Creates new database with provided SQLite database |
There was a problem hiding this comment.
"Create new table in provided SQLite database"
| } | ||
|
|
||
| /** | ||
| * Deletes existing database |
| } | ||
|
|
||
| /** | ||
| * Logs in false |
There was a problem hiding this comment.
Not sure what this does, so please remove this javadoc, thanks!
| } | ||
|
|
||
| /** | ||
| * Computes arc length between 2 points |
| } | ||
|
|
||
| /** | ||
| * Gets twice the amount of arc sine of (x)^(1/2) |
There was a problem hiding this comment.
"Calculate the inverse haversine of an angle. See https://en.wikipedia.org/wiki/Haversine_formula"
| /** | ||
| * Computes square sine function for half of the value entered | ||
| * @param x Angle in radians | ||
| * @return One-forth of square of sine function |
There was a problem hiding this comment.
Not exactly ;-) You can leave this one empty.
| } | ||
|
|
||
| /** | ||
| * Computes square sine function for half of the value entered |
build.gradle
Outdated
| } | ||
| dependencies { | ||
| classpath "com.android.tools.build:gradle:${project.gradleVersion}" | ||
| classpath 'com.android.tools.build:gradle:3.0.1' |
| return ""; | ||
| } | ||
| // FIXME: Gross hack bercause my regex skills suck maybe or I am too lazy who knows | ||
| // FIXME: Gross hack because my regex skills suck maybe or I am too lazy who knows |
Added JavaDoc comments to few Java classes.