Resolve WES-181 "Missing code doc"

This commit is contained in:
Dries Van Schuylenbergh
2023-05-14 20:18:29 +00:00
committed by Louis Adriaens
parent 7505ae7262
commit 3d99184717
67 changed files with 686 additions and 198 deletions

View File

@@ -93,6 +93,9 @@ public class CoursesController : AbstractFeedback
/// </summary>
private Image feedbackProgressImage;
/// <summary>
/// Reference to the video player
/// </summary>
public VideoPlayer videoPlayer;
/// <summary>
@@ -206,7 +209,7 @@ public class CoursesController : AbstractFeedback
/// </summary>
public void StartCourseController()
{
// Setting up course
course = courselist.courses[courselist.currentCourseIndex];
maxWords = course.theme.learnables.Count;
@@ -333,9 +336,10 @@ public class CoursesController : AbstractFeedback
private GameObject SetupPanel()
{
if (corruptPanelId == true)
{
{
(currentWordIndex, panelId) = (1, CorruptedPanelIDValue);
} else
}
else
{
(currentWordIndex, panelId) = FetchSign().ToValueTuple();
}
@@ -432,7 +436,7 @@ public class CoursesController : AbstractFeedback
if (currentWordIndex < course.theme.learnables.Count && panelId != 1 && !hasAnswered)
{
// Get current sign
Learnable sign = course.theme.learnables[currentWordIndex];
string currentSign = sign.name.ToUpper().Replace(" ", "-");
@@ -552,6 +556,10 @@ public class CoursesController : AbstractFeedback
}
/// <summary>
/// Wait 0.75 seconds and proceed to the next sign
/// </summary>
/// <returns></returns>
private IEnumerator WaitNextSign()
{
// Wait for 0.75 seconds
@@ -588,7 +596,7 @@ public class CoursesController : AbstractFeedback
UserList.Save();
SystemController.GetInstance().BackToPreviousScene();
}
/// <summary>
/// Returns panelId for testing
/// </summary>
@@ -597,6 +605,7 @@ public class CoursesController : AbstractFeedback
{
return panelId;
}
/// <summary>
/// Returns currentSign for testing
/// </summary>
@@ -606,6 +615,7 @@ public class CoursesController : AbstractFeedback
Learnable sign = course.theme.learnables[currentWordIndex];
return sign.name.ToUpper().Replace(" ", "-");
}
/// <summary>
/// Used for testing an out of bounds PanelId
/// </summary>
@@ -642,6 +652,4 @@ public class CoursesController : AbstractFeedback
CorruptedPanelIDValue = 1;
yield return CRNextSign();
}
}