diff --git a/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/GpsState.java b/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/GpsState.java index f35ab7a5..f6d9bf0b 100644 --- a/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/GpsState.java +++ b/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/GpsState.java @@ -11,6 +11,7 @@ import android.provider.Settings; /** + * A class for high level access to the phone's gps data. * * @since 0.1 */ diff --git a/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/WifiBroadcastReceiver.java b/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/WifiBroadcastReceiver.java index c7d3a8e0..a9c77fb4 100644 --- a/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/WifiBroadcastReceiver.java +++ b/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/WifiBroadcastReceiver.java @@ -12,6 +12,8 @@ /** * @author hjorthjort * Created 26/09/15 + * + * Class for delegating new about changed wifi states to all interested listeners * @since 0.1 */ public class WifiBroadcastReceiver extends BroadcastReceiver { diff --git a/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/WifiHelper.java b/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/WifiHelper.java index 9b3a01c2..2c557165 100644 --- a/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/WifiHelper.java +++ b/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/WifiHelper.java @@ -13,7 +13,7 @@ * @author hjorthjort * Created 24/09/15 * - * Singleton tool for getting wifi information + * Singleton tool for getting wifi information, such as nearby wifis and the current connection, if any. * @since 0.1 */ public class WifiHelper { diff --git a/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/api/ElectricityAdapter.java b/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/api/ElectricityAdapter.java index f5ecd426..103f898c 100644 --- a/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/api/ElectricityAdapter.java +++ b/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/api/ElectricityAdapter.java @@ -1,6 +1,11 @@ package com.alive_n_clickin.commutity.infrastructure.api; /** + * This class is not meant to be instantiated. The reason is to remove as much coupling as possible. + * Use the ApiAdapterFactory to gain access to this class. {@link ApiAdapterFactory} + * + * This class represents high level methods that crate suitable request string, which are + * then passed along to {@link ElectricityApiConnection} * * @since 0.1 */ diff --git a/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/api/VasttrafikAdapter.java b/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/api/VasttrafikAdapter.java index a38aaeeb..226921ed 100644 --- a/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/api/VasttrafikAdapter.java +++ b/app/src/main/java/com/alive_n_clickin/commutity/infrastructure/api/VasttrafikAdapter.java @@ -9,7 +9,8 @@ * This class is not meant to be instantiated. The reason is to remove as much coupling as possible. * Use the ApiAdapterFactory to gain access to this class. {@link ApiAdapterFactory} * - * This class is used to create a suitable request string, which is then passed along to {@link VasttrafikApiConnection} + * This class represents high level methods that crate suitable request string, which are + * then passed along to {@link VasttrafikApiConnection} * @since 0.1 */ class VasttrafikAdapter implements IVasttrafikAdapter { diff --git a/app/src/main/java/com/alive_n_clickin/commutity/presentation/flagreport/WifiChangeListener.java b/app/src/main/java/com/alive_n_clickin/commutity/presentation/flagreport/WifiChangeListener.java index b6976950..fa4cf709 100644 --- a/app/src/main/java/com/alive_n_clickin/commutity/presentation/flagreport/WifiChangeListener.java +++ b/app/src/main/java/com/alive_n_clickin/commutity/presentation/flagreport/WifiChangeListener.java @@ -3,6 +3,8 @@ /** * @author hjorthjort * Created 26/09/15 + * A listener that can be implemented to listen to events from the + * {@link com.alive_n_clickin.commutity.infrastructure.WifiBroadcastReceiver} * @since 0.1 */ public interface WifiChangeListener { diff --git a/app/src/main/java/com/alive_n_clickin/commutity/util/LogUtils.java b/app/src/main/java/com/alive_n_clickin/commutity/util/LogUtils.java index 2c5ad796..26e03614 100644 --- a/app/src/main/java/com/alive_n_clickin/commutity/util/LogUtils.java +++ b/app/src/main/java/com/alive_n_clickin/commutity/util/LogUtils.java @@ -3,10 +3,20 @@ /** * @author hjorthjort * Created 22/09/15 + * Instead of generating Android log tags in every class that does logging, this class can be used. + * Simply pass yourself (the current object) to the method of this class, and a suitable string will + * be returned. * * @since 0.1 */ public class LogUtils { + + /** + * Generates a log tag based on the class name + * + * @param caller the object that requests the tag + * @return the simple name of the class, e.g. "Integer" if the caller parameter is an Integer object. + */ public static String getLogTag(Object caller) { return caller.getClass().getSimpleName(); }