BUGFIX: updated comments

app/src/main/java/cmu/xprize/robotutor/tutorengine/QuickDebugTutorList.java

@@ -56,12 +56,14 @@ public class QuickDebugTutorList {
     }
 
     static {
+        // BACKUP PLAN: remove story.pic from the English matrix.
         QuickDebugTutor bug1 = new QuickDebugTutor(
           "story.pic.hear",
                 "story.pic.hear::1_1",
                 "[encfolder]1_1"
         );
         bug1.setComment("Shows three ? images instead of pictures");
+        bug1.setLocation("OPEN_SOURCE (1) - does not account for pages without images");
         bug1.setPriority(QuickDebugTutor.Priority.MUST);
         toFixBugMap.put("story_1_1:images", bug1);
 
@@ -70,7 +72,8 @@ public class QuickDebugTutorList {
                 "story.pic.hear::1_2",
                 "[encfolder]1_2"
         );
-        bug2.setComment("After 'they used dogs to help them' gets STUCK");
+        bug2.setComment("After 'When they were moving they came across two guinea fowls.' gets STUCK");
+        bug2.setLocation("UNKNOWN - no error output shown. Could be issue with storydata.json");
         bug2.setPriority(QuickDebugTutor.Priority.SHOULD);
         toFixBugMap.put("story_1_2:STUCK", bug2);
 
@@ -79,35 +82,43 @@ public class QuickDebugTutorList {
                 "story.pic.hear::2_1",
                 "[encfolder]2_1"
         );
-        bug3.setComment("STUCK page 2 after reading 'guinea fowls'");
+        bug3.setComment("Shows two images with question marks.");
         bug3.setPriority(QuickDebugTutor.Priority.SHOULD);
-        toFixBugMap.put("story_2_1:STUCK", bug3);
+        toFixBugMap.put("story_2_1:images", bug3);
 
+        // TO CHECK
+    }
+
+    // NON-TUTOR bugs
+    static {
+
+    }
+
+    // --------
+    // RESOLVED as of 5/9/2019
+    // --------
+    static {
         QuickDebugTutor bug4 = new QuickDebugTutor(
-          "story.parrot",
+                "story.parrot",
                 "story.parrot::ee2iy_sound",
                 "[encfolder]ee2iy_sound"
         );
         bug4.setComment("should not say 'repeat after me' before reading to kid");
         bug4.setPriority(QuickDebugTutor.Priority.SHOULD);
         toFixBugMap.put("story.parrot:prompt", bug4);
+        bug4.resolve();
 
         QuickDebugTutor bug5 = new QuickDebugTutor(
                 "akira",
                 "akira:wrd.dolch_2nd_grade",
-                "[file]akira_wrd.dolch_2nd_grade"
+                "[file]akira_wrd.dolch_2nd_grade.json"
         );
-        bug4.setComment("'us' recorded as 'US'. Should prompt 'tap on your answer'");
-        bug4.setPriority(QuickDebugTutor.Priority.COULD);
-        toFixBugMap.put("akira:audio", bug4);
-    }
-
-    // NON-TUTOR bugs
-    static {
-
+        bug5.setComment("'us' recorded as 'US'. Should prompt 'tap on your answer'");
+        bug5.setPriority(QuickDebugTutor.Priority.COULD);
+        toFixBugMap.put("akira:audio", bug5);
+        bug5.resolve();
     }
 
-
     // --------
     // RESOLVED as of 5/8/2019
     // --------

comp_questions/src/main/java/cmu/xprize/comp_questions/CQn_ViewManagerASB.java

@@ -106,7 +106,7 @@ public class CQn_ViewManagerASB implements ICQn_ViewManager, ILoadableObject  {
     private boolean                 cloze_page_mode = false;
     private boolean                 isClozePage = false;
     private ViewGroup               mPicturePage;
-    private int                     numPicMatch;
+    private int                     numPicMatch; // OPEN_SOURCE how does this get set???
     private ImageView               mMatchImage1;
     private ImageView               mMatchImage3;
     private ImageView               mMatchImage2;
@@ -948,11 +948,12 @@ public void disableImageButtons(){
      *
      */
     public void flipPage() {
+        // OPEN_SOURCE (1)... this does not account for pages without images
         if (mPageCount-mCurrPage <= 3) { // PIC_CHOICE this gave me numPicMatch = 4 when it was supposed to be 2 or 3
             // Last 4 images; don't randomize
-            this.numPicMatch = (mPageCount-mCurrPage); // PIC_CHOICE this sets to 4 when it shouldn't be. It should be two (numPicMatch too big)
+            this.numPicMatch = (mPageCount-mCurrPage); // OPEN_SOURCE is this the assignment?
         } else {
-            this.numPicMatch = getRandomNumberInRange(2, 4);
+            this.numPicMatch = getRandomNumberInRange(2, 4);  // OPEN_SOURCE is this the assignment?
         }
         Log.d(TAG, "flipPage: asdfad "+this.numPicMatch);
 
@@ -2619,7 +2620,7 @@ public void displayPictureMatching(){
             InputStream in2;
             InputStream in3;
             ArrayList<String> imgs = new ArrayList<>();
-            for (int i = mCurrPage+1; i < data.length; i++){
+            for (int i = mCurrPage+1; i < data.length; i++){ // OPEN_SOURCE data[2].image == "null"... why?
                 if (!imgs.contains(data[i].image)){
                     imgs.add(data[i].image);
                 }
@@ -2631,7 +2632,7 @@ public void displayPictureMatching(){
                 if (assetLocation.equals(TCONST.EXTERN)) {
                     in1 = new FileInputStream(mAsset + data[mCurrPage].image); // ZZZ load image
                     in2 = new FileInputStream(mAsset + randImg1); // ZZZ load image
-                    in3 = new FileInputStream(mAsset + randImg2); // OPEN_SOURCE not enough images for picmatch
+                    in3 = new FileInputStream(mAsset + randImg2); // OPEN_SOURCE null image... why?
                 } else {
                     in1 = JSON_Helper.assetManager().open(mAsset + data[mCurrPage].image); // ZZZ load image
                     in2 = JSON_Helper.assetManager().open(mAsset + randImg1); // ZZZ load image

util/src/main/java/cmu/xprize/util/CTutorData_Metadata.java

@@ -228,8 +228,19 @@ public static String getThumbName(CAt_Data tutor) {
         return null;
     }
 
+    /**
+     * Given a tutor, return a list of Strings that describes the tutor.
+     * @param tutor
+     * @return
+     */
     public static ArrayList<String> parseNameIntoLabels(CAt_Data tutor) {
 
+        // OPEN_SOURCE FIXME
+        // write.ltr.uc.trc:A..D_asc
+        // bpop.ltr.lc:A..D.asc.show.mc
+        // akira.wrd.a2AE
+        // write.wrd:phon.m2M
+
         Log.d("CHUNT", "tutor_desc = " + tutor.tutor_desc);
         // tutortype is first token... e.g. "story.hear" --> "story"
         String[] tutorDesc = tutor.tutor_desc.split("\\.");
@@ -615,7 +626,7 @@ private static ArrayList<String> processAkiraTutorId(CAt_Data tutor, ArrayList<S
 
         // CHUNT 4/14
 
-        // CHUNT LIT
+        // CHUNT LIT... these should be put into a Test Class.
         // akira:ltr.lc_A..D_rand
         // akira:ltr.lc_E..G_rand --> "Identify null"
         // akira:wrd.a2AE --> "Identify null"