Skip to content

Commit 38a6743

Browse files
committed
Added documentations
1 parent 7132a74 commit 38a6743

File tree

102 files changed

+360
-3
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+360
-3
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@
5656
import static org.hamcrest.core.IsInstanceOf.instanceOf;
5757

5858
/**
59+
* Espresso test designed to test all the functionalities of Comprehension template
5960
* Created by anupam (opticod) on 7/6/16.
6061
*/
6162

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@
1616
/**
1717
* Created by scopeinfinity on 10/3/16.
1818
*/
19+
20+
/**
21+
* @brief Adapter used for DraftsFragment to show the items
22+
*/
1923
public class DraftProjectAdapter extends BaseAdapter {
2024

2125
private final Context mContext;

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
/**
44
* Created by Anupam (opticod) on 5/6/16.
55
*/
6+
7+
/**
8+
* @brief Constants used in comprehension template's simulator relating databases.
9+
*/
610
public class Constants {
711
public static final String firstrun = "firstRun";
812
public static final int COL_TITLE = 1;

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
* Created by Anupam (opticod) on 5/6/16.
77
*/
88

9+
/**
10+
* @brief Contains database contracts for comprehension template's simulator.
11+
*/
12+
913
class ComprehensionContract {
1014

1115
public static final class Questions implements BaseColumns {

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@
1111
* Created by Anupam (opticod) on 5/6/16.
1212
*/
1313

14+
/**
15+
* @brief DatabaseHelper for comprehension template's simulator.
16+
*/
17+
1418
class ComprehensionDBHelper extends SQLiteOpenHelper {
1519

1620
private static final String DATABASE_NAME = "comprehension.db";

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@
1616
/**
1717
* Created by Anupam (opticod) on 5/6/16.
1818
*/
19+
20+
/**
21+
* @brief Contains database util functions for comprehension template's simulator.
22+
*/
1923
public class ComprehensionDb {
2024

2125
private static final String EQUAL = " == ";

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@
1414
/**
1515
* Created by Anupam (opticod) on 5/6/16.
1616
*/
17+
18+
/**
19+
* @brief Contains xml data utils for comprehension template's simulator.
20+
*/
1721
public class DataUtils {
1822

1923
public static String[] readTitleAuthor() {

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@
2828
/**
2929
* Created by Anupam (opticod) on 5/6/16.
3030
*/
31+
32+
/**
33+
* @brief Used to parse XML and save in database for comprehension template's simulator.
34+
*/
3135
public class FetchXMLTask extends AsyncTask<String, Void, Void> {
3236

3337
private final Context mContext;

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@
2323
/**
2424
* Created by Anupam (opticod) on 5/6/16.
2525
*/
26+
27+
/**
28+
* @brief Last Fragment for comprehension template's simulator.
29+
*/
2630
public class LastFragment extends Fragment {
2731

2832
public static Fragment newInstance() {

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@
3131
/**
3232
* Created by Anupam (opticod) on 5/6/16.
3333
*/
34+
35+
/**
36+
* @brief Main Fragment for comprehension template's simulator.
37+
*/
38+
3439
public class MainFragment extends Fragment implements NavigationView.OnNavigationItemSelectedListener {
3540

3641
private View rootView;

0 commit comments

Comments
 (0)