Add missing javadocs nearby #1828 Tidy up code in entire Nearby package and write Javadocs for all Nearby classes and methods

[neslihanturan]

Description (required)

Fixes #1828 Tidy up code in entire Nearby package and write Javadocs for all Nearby classes and methods

What changes did you make and why?

Added missing javadocs in some Nearby classes.

Tests performed (required)

Tested betaDebug API 26

[codecov-io]

Codecov Report

Merging #2133 into master will increase coverage by 0.19%.
The diff coverage is 0%.

@@            Coverage Diff            @@
##           master   #2133      +/-   ##
=========================================
+ Coverage    5.52%   5.72%   +0.19%     
=========================================
  Files         234     231       -3     
  Lines       11596   11587       -9     
  Branches     1079    1078       -1     
=========================================
+ Hits          641     663      +22     
+ Misses      10902   10869      -33     
- Partials       53      55       +2

Impacted Files	Coverage Δ
...a/fr/free/nrw/commons/nearby/NearbyController.java	0% <ø> (ø)	⬆️
.../fr/free/nrw/commons/di/FragmentBuilderModule.java	0% <ø> (ø)	⬆️
.../nrw/commons/nearby/NearbyNoificationCardView.java	0% <ø> (ø)	⬆️
.../java/fr/free/nrw/commons/nearby/NearbyPlaces.java	0% <ø> (ø)	⬆️
...fr/free/nrw/commons/nearby/NearbyListFragment.java	0% <ø> (ø)	⬆️
...ava/fr/free/nrw/commons/nearby/NearbyFragment.java	0% <0%> (ø)	⬆️
.../fr/free/nrw/commons/nearby/NearbyMapFragment.java	0% <0%> (ø)	⬆️
...a/fr/free/nrw/commons/utils/ContributionUtils.java	6.77% <0%> (-5.35%)	⬇️
...n/java/fr/free/nrw/commons/auth/LoginActivity.java	0% <0%> (ø)	⬆️
...free/nrw/commons/campaigns/CampaignsPresenter.java	0% <0%> (ø)	⬆️
... and 24 more

---

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 932c75a...02ac4ef. Read the comment docs.

[domdomegg]

Seems fine if I rebase, but without rebasing unit testing fails at UploadModelTest

If Travis fails in the unit tests, might be worth rebasing.

io.reactivex.exceptions.OnErrorNotImplementedException: The mapper function returned a null value.
	at io.reactivex.internal.functions.Functions$OnErrorMissingConsumer.accept(Functions.java:704)
	at io.reactivex.internal.functions.Functions$OnErrorMissingConsumer.accept(Functions.java:701)
	at io.reactivex.internal.observers.ConsumerSingleObserver.onError(ConsumerSingleObserver.java:47)
	at io.reactivex.internal.operators.single.SingleZipArray$ZipCoordinator.innerError(SingleZipArray.java:139)
	at io.reactivex.internal.operators.single.SingleZipArray$ZipSingleObserver.onError(SingleZipArray.java:177)
	at io.reactivex.internal.operators.single.SingleMap$MapSingleObserver.onError(SingleMap.java:69)
	at io.reactivex.internal.operators.single.SingleMap$MapSingleObserver.onError(SingleMap.java:69)
	at io.reactivex.internal.operators.single.SingleMap$MapSingleObserver.onSuccess(SingleMap.java:60)
	at io.reactivex.internal.operators.single.SingleFromCallable.subscribeActual(SingleFromCallable.java:56)
	at io.reactivex.Single.subscribe(Single.java:3394)
	at io.reactivex.internal.operators.single.SingleMap.subscribeActual(SingleMap.java:34)
	at io.reactivex.Single.subscribe(Single.java:3394)
	at io.reactivex.internal.operators.single.SingleMap.subscribeActual(SingleMap.java:34)
	at io.reactivex.Single.subscribe(Single.java:3394)
	at io.reactivex.internal.operators.single.SingleZipArray.subscribeActual(SingleZipArray.java:64)
	at io.reactivex.Single.subscribe(Single.java:3394)
	at io.reactivex.Single.subscribe(Single.java:3380)
	at io.reactivex.Single.subscribe(Single.java:3351)
	at fr.free.nrw.commons.upload.UploadModel.receiveDirect(UploadModel.java:146)
	at fr.free.nrw.commons.upload.UploadModelTest.isTopCardStateForDirectUpload(UploadModelTest.kt:226)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:498)
	at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:50)
	at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
	at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:47)
	at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17)
	at org.junit.internal.runners.statements.RunBefores.evaluate(RunBefores.java:26)
	at org.junit.internal.runners.statements.RunAfters.evaluate(RunAfters.java:27)
	at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:325)
	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:78)
	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:57)
	at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290)
	at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71)
	at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288)
	at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58)
	at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268)
	at org.junit.runners.ParentRunner.run(ParentRunner.java:363)
	at org.junit.runners.Suite.runChild(Suite.java:128)
	at org.junit.runners.Suite.runChild(Suite.java:27)
	at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290)
	at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71)
	at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288)
	at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58)
	at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268)
	at org.junit.runners.ParentRunner.run(ParentRunner.java:363)
	at org.junit.runner.JUnitCore.run(JUnitCore.java:137)
	at com.intellij.junit4.JUnit4IdeaTestRunner.startRunnerWithArgs(JUnit4IdeaTestRunner.java:68)
	at com.intellij.rt.execution.junit.IdeaTestRunner$Repeater.startRunnerWithArgs(IdeaTestRunner.java:47)
	at com.intellij.rt.execution.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:242)
	at com.intellij.rt.execution.junit.JUnitStarter.main(JUnitStarter.java:70)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:498)
	at com.intellij.rt.execution.application.AppMainV2.main(AppMainV2.java:131)
Caused by: java.lang.NullPointerException: The mapper function returned a null value.
	at io.reactivex.internal.functions.ObjectHelper.requireNonNull(ObjectHelper.java:39)
	at io.reactivex.internal.operators.single.SingleMap$MapSingleObserver.onSuccess(SingleMap.java:57)
	... 49 more

[domdomegg]

Travis seems okay with unit tests. As unit tests are fine once rebased I'm happy.

Tested 2.9.0-debug-pr-2133~02ac4efaa on Samsung Galaxy S6 at API level 25