Added documentations

Author: opticod

source-code/app/src/androidTest/java/org/buildmlearn/toolkit/espresso/ComprehensionTest.java

@@ -56,6 +56,7 @@
 import static org.hamcrest.core.IsInstanceOf.instanceOf;
 
 /**
+ * Espresso test designed to test all the functionalities of Comprehension template
  * Created by anupam (opticod) on 7/6/16.
  */
 

source-code/app/src/main/java/org/buildmlearn/toolkit/adapter/DraftProjectAdapter.java

@@ -16,6 +16,10 @@
 /**
  * Created by scopeinfinity on 10/3/16.
  */
+
+/**
+ * @brief Adapter used for DraftsFragment to show the items
+ */
 public class DraftProjectAdapter extends BaseAdapter {
 
     private final Context mContext;

source-code/app/src/main/java/org/buildmlearn/toolkit/comprehensiontemplate/Constants.java

@@ -3,6 +3,10 @@
 /**
  * Created by Anupam (opticod) on 5/6/16.
  */
+
+/**
+ * @brief Constants used in comprehension template's simulator relating databases.
+ */
 public class Constants {
     public static final String firstrun = "firstRun";
     public static final int COL_TITLE = 1;

source-code/app/src/main/java/org/buildmlearn/toolkit/comprehensiontemplate/data/ComprehensionContract.java

@@ -6,6 +6,10 @@
  * Created by Anupam (opticod) on 5/6/16.
  */
 
+/**
+ * @brief Contains database contracts for comprehension template's simulator.
+ */
+
 class ComprehensionContract {
 
     public static final class Questions implements BaseColumns {

source-code/app/src/main/java/org/buildmlearn/toolkit/comprehensiontemplate/data/ComprehensionDBHelper.java

@@ -11,6 +11,10 @@
  * Created by Anupam (opticod) on 5/6/16.
  */
 
+/**
+ * @brief DatabaseHelper for comprehension template's simulator.
+ */
+
 class ComprehensionDBHelper extends SQLiteOpenHelper {
 
     private static final String DATABASE_NAME = "comprehension.db";

source-code/app/src/main/java/org/buildmlearn/toolkit/comprehensiontemplate/data/ComprehensionDb.java

@@ -16,6 +16,10 @@
 /**
  * Created by Anupam (opticod) on 5/6/16.
  */
+
+/**
+ * @brief Contains database util functions for comprehension template's simulator.
+ */
 public class ComprehensionDb {
 
     private static final String EQUAL = " == ";

source-code/app/src/main/java/org/buildmlearn/toolkit/comprehensiontemplate/data/DataUtils.java

@@ -14,6 +14,10 @@
 /**
  * Created by Anupam (opticod) on 5/6/16.
  */
+
+/**
+ * @brief Contains xml data utils for comprehension template's simulator.
+ */
 public class DataUtils {
 
     public static String[] readTitleAuthor() {

source-code/app/src/main/java/org/buildmlearn/toolkit/comprehensiontemplate/data/FetchXMLTask.java

@@ -28,6 +28,10 @@
 /**
  * Created by Anupam (opticod) on 5/6/16.
  */
+
+/**
+ * @brief Used to parse XML and save in database for comprehension template's simulator.
+ */
 public class FetchXMLTask extends AsyncTask<String, Void, Void> {
 
     private final Context mContext;

source-code/app/src/main/java/org/buildmlearn/toolkit/comprehensiontemplate/fragment/LastFragment.java

@@ -23,6 +23,10 @@
 /**
  * Created by Anupam (opticod) on 5/6/16.
  */
+
+/**
+ * @brief Last Fragment for comprehension template's simulator.
+ */
 public class LastFragment extends Fragment {
 
     public static Fragment newInstance() {

source-code/app/src/main/java/org/buildmlearn/toolkit/comprehensiontemplate/fragment/MainFragment.java

@@ -31,6 +31,11 @@
 /**
  * Created by Anupam (opticod) on 5/6/16.
  */
+
+/**
+ * @brief Main Fragment for comprehension template's simulator.
+ */
+
 public class MainFragment extends Fragment implements NavigationView.OnNavigationItemSelectedListener {
 
     private View rootView;

source-code/app/src/main/java/org/buildmlearn/toolkit/comprehensiontemplate/fragment/QuestionFragment.java

@@ -30,6 +30,10 @@
 /**
  * Created by Anupam (opticod) on 5/6/16.
  */
+
+/**
+ * @brief Question Fragment for comprehension template's simulator.
+ */
 public class QuestionFragment extends Fragment
         implements NavigationView.OnNavigationItemSelectedListener {
 

source-code/app/src/main/java/org/buildmlearn/toolkit/comprehensiontemplate/fragment/SplashFragment.java

@@ -19,6 +19,10 @@
 /**
  * Created by Anupam (opticod) on 5/6/16.
  */
+
+/**
+ * @brief Splash intro Fragment for comprehension template's simulator.
+ */
 public class SplashFragment extends Fragment {
 
     public static Fragment newInstance(String path) {

source-code/app/src/main/java/org/buildmlearn/toolkit/dictationtemplate/Constants.java

@@ -5,6 +5,10 @@
 /**
  * Created by Anupam (opticod) on 10/7/16.
  */
+
+/**
+ * @brief Constants used in dictation template's simulator relating databases.
+ */
 public class Constants {
     public static final String[] DICT_COLUMNS = {
             DictContract.Dict.TABLE_NAME + "." + DictContract.Dict._ID,

source-code/app/src/main/java/org/buildmlearn/toolkit/dictationtemplate/adapter/DictArrayAdapter.java

@@ -15,6 +15,10 @@
 /**
  * Created by Anupam (opticod) on 10/7/16.
  */
+
+/**
+ * @brief Custom Adapter for dictation template's simulator.
+ */
 public class DictArrayAdapter extends CursorAdapter {
 
     public DictArrayAdapter(Context context) {

source-code/app/src/main/java/org/buildmlearn/toolkit/dictationtemplate/data/DataUtils.java

@@ -14,6 +14,10 @@
 /**
  * Created by Anupam (opticod) on 10/7/16.
  */
+
+/**
+ * @brief Contains xml data utils for dictation template's simulator.
+ */
 public class DataUtils {
 
     public static String[] readTitleAuthor() {

source-code/app/src/main/java/org/buildmlearn/toolkit/dictationtemplate/data/DictContract.java

@@ -6,6 +6,10 @@
  * Created by Anupam (opticod) on 10/7/16.
  */
 
+/**
+ * @brief Contains database contracts for dictation template's simulator.
+ */
+
 public class DictContract {
 
     public static final class Dict implements BaseColumns {

source-code/app/src/main/java/org/buildmlearn/toolkit/dictationtemplate/data/DictDBHelper.java

@@ -10,6 +10,10 @@
  * Created by Anupam (opticod) on 10/7/16.
  */
 
+/**
+ * @brief DatabaseHelper for dictation template's simulator.
+ */
+
 class DictDBHelper extends SQLiteOpenHelper {
 
     private static final String DATABASE_NAME = "dictation.db";

source-code/app/src/main/java/org/buildmlearn/toolkit/dictationtemplate/data/DictDb.java

@@ -11,6 +11,10 @@
 /**
  * Created by Anupam (opticod) on 10/7/16.
  */
+
+/**
+ * @brief Contains database util functions for dictation template's simulator.
+ */
 public class DictDb {
 
     private static final String EQUAL = " == ";

source-code/app/src/main/java/org/buildmlearn/toolkit/dictationtemplate/data/DictModel.java

@@ -6,6 +6,10 @@
 /**
  * Created by Anupam (opticod) on 10/7/16.
  */
+
+/**
+ * @brief Model used to save dict entries in database for comprehension template's simulator.
+ */
 public class DictModel implements Parcelable {
     public final static Parcelable.Creator<DictModel> CREATOR = new Parcelable.Creator<DictModel>() {
         @Override

source-code/app/src/main/java/org/buildmlearn/toolkit/dictationtemplate/data/FetchXMLTask.java

@@ -24,6 +24,11 @@
 /**
  * Created by Anupam (opticod) on 10/7/16.
  */
+
+/**
+ * @brief Used to parse XML and save in database for dictation template's simulator.
+ */
+
 public class FetchXMLTask extends AsyncTask<String, Void, Void> {
 
     private final Context mContext;

source-code/app/src/main/java/org/buildmlearn/toolkit/dictationtemplate/fragment/DetailActivityFragment.java

@@ -36,6 +36,10 @@
 /**
  * Created by Anupam (opticod) on 10/7/16.
  */
+
+/**
+ * @brief Fragment for taking user input(dictation) in dictation template's simulator.
+ */
 public class DetailActivityFragment extends Fragment implements LoaderCallbacks<Cursor> {
 
     private static final int DETAIL_LOADER = 0;

source-code/app/src/main/java/org/buildmlearn/toolkit/dictationtemplate/fragment/MainActivityFragment.java

@@ -33,6 +33,10 @@
 /**
  * Created by Anupam (opticod) on 10/7/16.
  */
+
+/**
+ * @brief Fragment to hear dictation in dictation template's simulator.
+ */
 public class MainActivityFragment extends Fragment implements LoaderManager.LoaderCallbacks<Cursor> {
 
     private static final String SELECTED_KEY = "selected_position";

source-code/app/src/main/java/org/buildmlearn/toolkit/dictationtemplate/fragment/ResultActivityFragment.java

@@ -32,6 +32,10 @@
 /**
  * Created by Anupam (opticod) on 10/7/16.
  */
+
+/**
+ * @brief Fragment for displaying score to user in dictation template's simulator.
+ */
 public class ResultActivityFragment extends Fragment implements LoaderCallbacks<Cursor> {
 
     private static final int DETAIL_LOADER = 0;

source-code/app/src/main/java/org/buildmlearn/toolkit/dictationtemplate/fragment/SplashFragment.java

@@ -19,6 +19,10 @@
 /**
  * Created by Anupam (opticod) on 10/7/16.
  */
+
+/**
+ * @brief Splash intro Fragment for dictation template's simulator.
+ */
 public class SplashFragment extends Fragment {
 
     public static Fragment newInstance(String path) {

source-code/app/src/main/java/org/buildmlearn/toolkit/flashcardtemplate/Constants.java

@@ -3,6 +3,10 @@
 /**
  * Created by Anupam (opticod) on 10/8/16.
  */
+
+/**
+ * @brief Constants used in flash card template's simulator relating databases.
+ */
 public class Constants {
     public static final String firstrun = "firstRun";
     public static final int COL_QUESTION = 1;

source-code/app/src/main/java/org/buildmlearn/toolkit/flashcardtemplate/data/DataUtils.java

@@ -13,6 +13,10 @@
 /**
  * Created by Anupam (opticod) on 10/8/16.
  */
+
+/**
+ * @brief Contains xml data utils for flash card template's simulator.
+ */
 public class DataUtils {
 
     public static String[] readTitleAuthor() {

source-code/app/src/main/java/org/buildmlearn/toolkit/flashcardtemplate/data/FetchXMLTask.java

@@ -24,6 +24,11 @@
 /**
  * Created by Anupam (opticod) on 10/8/16.
  */
+
+/**
+ * @brief Used to parse XML and save in database for flash card template's simulator.
+ */
+
 public class FetchXMLTask extends AsyncTask<String, Void, Void> {
 
     private final Context mContext;

source-code/app/src/main/java/org/buildmlearn/toolkit/flashcardtemplate/data/FlashContract.java

@@ -6,6 +6,9 @@
  * Created by Anupam (opticod) on 10/8/16.
  */
 
+/**
+ * @brief Contains database contracts for flash card template's simulator.
+ */
 class FlashContract {
 
     public static final class FlashCards implements BaseColumns {

source-code/app/src/main/java/org/buildmlearn/toolkit/flashcardtemplate/data/FlashDBHelper.java

@@ -10,6 +10,9 @@
  * Created by Anupam (opticod) on 10/8/16.
  */
 
+/**
+ * @brief DatabaseHelper for flash card template's simulator.
+ */
 class FlashDBHelper extends SQLiteOpenHelper {
 
     private static final String DATABASE_NAME = "learn_flash.db";

source-code/app/src/main/java/org/buildmlearn/toolkit/flashcardtemplate/data/FlashDb.java

@@ -13,6 +13,10 @@
 /**
  * Created by Anupam (opticod) on 10/8/16.
  */
+
+/**
+ * @brief Contains database util functions for flash card template's simulator.
+ */
 public class FlashDb {
 
     private static final String EQUAL = " == ";

source-code/app/src/main/java/org/buildmlearn/toolkit/flashcardtemplate/data/FlashModel.java

@@ -6,6 +6,10 @@
 /**
  * Created by Anupam (opticod) on 10/8/16.
  */
+
+/**
+ * @brief Model used to save flash entries in database for flash card template's simulator.
+ */
 public class FlashModel implements Parcelable {
     public final static Creator<FlashModel> CREATOR = new Creator<FlashModel>() {
         @Override

source-code/app/src/main/java/org/buildmlearn/toolkit/flashcardtemplate/fragment/LastFragment.java

@@ -19,6 +19,10 @@
 /**
  * Created by anupam on 10/8/16.
  */
+
+/**
+ * @brief Fragment for displaying score to user in flash card template's simulator.
+ */
 public class LastFragment extends Fragment {
 
     public static Fragment newInstance() {

source-code/app/src/main/java/org/buildmlearn/toolkit/flashcardtemplate/fragment/MainFragment.java

@@ -44,6 +44,10 @@
 /**
  * Created by anupam on 10/8/16.
  */
+
+/**
+ * @brief Fragment containing the flash cards in dictation template's simulator.
+ */
 public class MainFragment extends Fragment implements NavigationView.OnNavigationItemSelectedListener {
 
     private ViewPager viewPager;

source-code/app/src/main/java/org/buildmlearn/toolkit/flashcardtemplate/fragment/SplashFragment.java

@@ -19,6 +19,10 @@
 /**
  * Created by Anupam (opticod) on 10/8/16.
  */
+
+/**
+ * @brief Splash intro Fragment for flash card template's simulator.
+ */
 public class SplashFragment extends Fragment {
 
     public static Fragment newInstance(String path) {

source-code/app/src/main/java/org/buildmlearn/toolkit/fragment/DraftsFragment.java

@@ -47,6 +47,10 @@
 /**
  * Created by scopeinfinity on 10/3/16.
  */
+
+/**
+ * @brief Fragment used to save drafts.
+ */
 public class DraftsFragment extends Fragment implements AbsListView.OnItemClickListener  {
 
     private static final String TAG = "Draft Project Fragment";

source-code/app/src/main/java/org/buildmlearn/toolkit/infotemplate/Constants.java

@@ -5,6 +5,10 @@
 /**
  * Created by Anupam (opticod) on 20/6/16.
  */
+
+/**
+ * @brief Constants used in info template's simulator relating databases.
+ */
 public class Constants {
     public static final String[] INFO_COLUMNS = {
             InfoContract.Info.TABLE_NAME + "." + InfoContract.Info._ID,