JavaDocs for classes

Author: kunall17

app/src/main/java/com/zulip/android/ZulipApp.java

@@ -37,6 +37,15 @@
 import org.json.JSONArray;
 import org.json.JSONException;
 
+/**
+ * Stores the global variables which are frequently used.
+ *
+ * {@link #max_message_id} This is the last Message ID stored in our database.
+ * {@link #you} A reference to the user currently logged in.
+ * {@link #api_key} Stores the API_KEY which was obtained from the server on successful authentication.
+ * {@link #mutedTopics} Stores the concatenated ID for the stream and topic (Same strings as {@link Message#getIdForHolder()}
+ * {@link #setupEmoji()} This is called to initialize and add records the existing emoticons in the assets folder.
+ */
 public class ZulipApp extends Application {
     private static final String API_KEY = "api_key";
     private static final String EMAIL = "email";

app/src/main/java/com/zulip/android/activities/AuthEmailAdapter.java

@@ -15,6 +15,9 @@
 
 import java.util.List;
 
+/**
+ * Adapter used for the RecyclerView here{@link DevAuthActivity} for showing Emails in the DevAuthBackend
+ */
 class AuthEmailAdapter extends RecyclerView.Adapter<AuthEmailAdapter.AuthEmailViewHolder> {
 
     private static final int VIEW_TYPE_HEADER = 0;

app/src/main/java/com/zulip/android/activities/DevAuthActivity.java

@@ -20,6 +20,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Activity where the Emails for the DevAuthBackend are displayed.
+ */
 public class DevAuthActivity extends Activity {
     private RecyclerView recyclerView;
     private ProgressDialog connectionProgressDialog;

app/src/main/java/com/zulip/android/activities/ExpandableStreamDrawerAdapter.java

@@ -13,6 +13,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Adapter for the left side drawer of the streams and subjects.
+ */
 public class ExpandableStreamDrawerAdapter extends SimpleCursorTreeAdapter {
 
     public ExpandableStreamDrawerAdapter(final Context context, Cursor cursor, int groupLayout,

app/src/main/java/com/zulip/android/activities/LegalActivity.java

@@ -7,6 +7,9 @@
 
 import com.zulip.android.R;
 
+/**
+ * Activity to display Legal Information
+ */
 public class LegalActivity extends Activity {
 
     @Override

app/src/main/java/com/zulip/android/activities/LoginActivity.java

@@ -36,6 +36,10 @@
 
 import java.util.List;
 
+/**
+ * Activity to Login through various backends on a specified server.
+ * Currently supported LoginAuths are Emailbackend and DevAuthBackend.
+ */
 public class LoginActivity extends AppCompatActivity implements View.OnClickListener,
         GoogleApiClient.OnConnectionFailedListener {
     private static final String TAG = "LoginActivity";

app/src/main/java/com/zulip/android/activities/MessageListFragment.java

@@ -41,7 +41,10 @@
 import java.util.Arrays;
 import java.util.List;
 
-
+/**
+ * This is a Fragment which holds the recyclerView for displaying the messages
+ * initiated and called by {@link ZulipActivity}
+ */
 public class MessageListFragment extends Fragment implements MessageListener {
     private static final int PIXEL_OFFSET_MESSAGE_HEADERS = 24;
     private LinearLayoutManager linearLayoutManager;

app/src/main/java/com/zulip/android/activities/RecyclerMessageAdapter.java

@@ -39,7 +39,19 @@
 import java.util.Arrays;
 import java.util.List;
 
-
+/**
+ * An adapter to bind the messages to a RecyclerView.
+ * This has two main ViewTypes {@link MessageHeaderParent.MessageHeaderHolder} and {@link MessageHolder}
+ * Each Message is inserted to its MessageHeader which are distinguished by the {@link Message#getIdForHolder()}
+ * saved in {@link MessageHeaderParent#getId()}
+ *
+ * There are two ways to insert a message in this adapter one {@link RecyclerMessageAdapter#addMessage(Message, int)}
+ * and second one {@link RecyclerMessageAdapter#addNewMessage(Message)}
+ * The first one is used to add old messages from the databases with {@link com.zulip.android.util.MessageListener.LoadPosition#BELOW}
+ * and {@link com.zulip.android.util.MessageListener.LoadPosition#INITIAL}. This is for the threaded view and the messages are added
+ * to the existing messageHeaderParents.
+ * In addNewMessages the messages are loaded in the bottom and new headers are created if it does not matches the last header.
+ */
 public class RecyclerMessageAdapter extends RecyclerView.Adapter<RecyclerView.ViewHolder> {
 
     public static final int VIEWTYPE_MESSAGE_HEADER = 1;

app/src/main/java/com/zulip/android/activities/ZulipActivity.java

@@ -94,6 +94,10 @@
 
 import org.json.JSONObject;
 
+/**
+ * The main Activity responsible for holding the {@link MessageListFragment} which has the list to the
+ * messages
+ * */
 public class ZulipActivity extends AppCompatActivity implements
         MessageListFragment.Listener, NarrowListener {
 

app/src/main/java/com/zulip/android/networking/AsyncCursorAdapterUpdater.java

@@ -8,6 +8,11 @@
 
 import com.zulip.android.util.ZLog;
 
+/**
+ * A background task which asynchronously updates data.
+ * Used here{@link com.zulip.android.activities.RefreshableCursorAdapter} for updating the
+ * online people in the person (right) drawer.
+ */
 public class AsyncCursorAdapterUpdater extends
         AsyncTask<String, String, Cursor> {