Skip to content

Commit

Permalink
Adds missing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hjorthjort committed Oct 2, 2015
1 parent 5f45c4e commit 8f341b6
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import android.provider.Settings;

/**
* A class for high level access to the phone's gps data.
*
* @since 0.1
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
Original file line number Diff line number Diff line change
@@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
10 changes: 10 additions & 0 deletions app/src/main/java/com/alive_n_clickin/commutity/util/LogUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -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();
}
Expand Down

0 comments on commit 8f341b6

Please sign in to comment.