Add comments

Author: alamkanak

sample/src/main/java/com/alamkanak/weekview/sample/AsynchronousActivity.java

@@ -16,6 +16,7 @@
 import retrofit.client.Response;
 
 /**
+ * An example of how events can be fetched from network and be displayed on the week view.
  * Created by Raquib-ul-Alam Kanak on 1/3/2014.
  * Website: http://alamkanak.github.io
  */
@@ -26,6 +27,9 @@ public class AsynchronousActivity extends BaseActivity implements Callback<List<
 
     @Override
     public List<? extends WeekViewEvent> onMonthChange(int newYear, int newMonth) {
+
+        // Download events from network if it hasn't been done already. To understand how events are
+        // downloaded using retrofit, visit http://square.github.io/retrofit
         if (!calledNetwork) {
             RestAdapter retrofit = new RestAdapter.Builder()
                     .setEndpoint("https://api.myjson.com/bins")
@@ -35,6 +39,7 @@ public List<? extends WeekViewEvent> onMonthChange(int newYear, int newMonth) {
             calledNetwork = true;
         }
 
+        // Return only the events that matches newYear and newMonth.
         List<WeekViewEvent> matchedEvents = new ArrayList<WeekViewEvent>();
         for (WeekViewEvent event : events) {
             if (eventMatches(event, newYear, newMonth)) {
@@ -44,6 +49,13 @@ public List<? extends WeekViewEvent> onMonthChange(int newYear, int newMonth) {
         return matchedEvents;
     }
 
+    /**
+     * Checks if an event falls into a specific year and month.
+     * @param event The event to check for.
+     * @param year The year.
+     * @param month The month.
+     * @return True if the event matches the year and month.
+     */
     private boolean eventMatches(WeekViewEvent event, int year, int month) {
         return (event.getStartTime().get(Calendar.YEAR) == year && event.getStartTime().get(Calendar.MONTH) == month - 1) || (event.getEndTime().get(Calendar.YEAR) == year && event.getEndTime().get(Calendar.MONTH) == month - 1);
     }

sample/src/main/java/com/alamkanak/weekview/sample/BaseActivity.java

@@ -18,6 +18,8 @@
 import java.util.Locale;
 
 /**
+ * This is a base activity which contains week view and all the codes necessary to initialize the
+ * week view.
  * Created by Raquib-ul-Alam Kanak on 1/3/2014.
  * Website: http://alamkanak.github.io
  */

sample/src/main/java/com/alamkanak/weekview/sample/BasicActivity.java

@@ -7,6 +7,7 @@
 import java.util.List;
 
 /**
+ * A basic example of how to use week view library.
  * Created by Raquib-ul-Alam Kanak on 1/3/2014.
  * Website: http://alamkanak.github.io
  */

sample/src/main/java/com/alamkanak/weekview/sample/MainActivity.java

@@ -7,6 +7,7 @@
 
 
 /**
+ * The launcher activity of the sample app. It contains the links to visit all the example screens.
  * Created by Raquib-ul-Alam Kanak on 7/21/2014.
  * Website: http://alamkanak.github.io
  */

sample/src/main/java/com/alamkanak/weekview/sample/apiclient/Event.java

@@ -13,6 +13,7 @@
 import java.util.Date;
 
 /**
+ * An event model that was built for automatic serialization from json to object.
  * Created by Raquib-ul-Alam Kanak on 1/3/16.
  * Website: http://alamkanak.github.io
  */