Add Javadoc stubs to Java sources (automated)

Author: Michael Ryan Hunsaker

src/main/java/com/studentgui/apphelpers/dto/AssessmentPayload.java

@@ -31,18 +31,20 @@ public AssessmentPayload(final int sessionIdParam, final String[] codesParam, fi
 
     @Override
     /**
-     * getSessionId - TODO: describe this method
-     * @return TODO: describe return value
+     * Return the numeric database session id associated with this payload.
+     *
+     * @return the session id stored in this payload
      */
-
     public int getSessionId() {
         return this.sessionId;
     }
 
     @Override
     /**
-     * toString - TODO: describe this method
-     * @return TODO: describe return value
+     * Return a compact, human-readable representation of this payload suitable
+     * for logging and diagnostics.
+     *
+     * @return a one-line string describing the payload contents
      */
 
     public String toString() {

src/main/java/com/studentgui/apphelpers/dto/ContactPayload.java

@@ -53,8 +53,9 @@ public ContactPayload(final int sessionIdParam, final String guardianParam, fina
 
     @Override
     /**
-     * getSessionId - TODO: describe this method
-     * @return TODO: describe return value
+     * Return the database session id associated with this contact payload.
+     *
+     * @return numeric session id for the recorded contact entry
      */
 
     public int getSessionId() { return this.sessionId; }

src/main/java/com/studentgui/apphelpers/dto/KeyboardingPayload.java

@@ -37,8 +37,9 @@ public KeyboardingPayload(final int sessionIdParam, final String programParam, f
 
     @Override
     /**
-     * getSessionId - TODO: describe this method
-     * @return TODO: describe return value
+     * Return the database session id associated with this keyboarding payload.
+     *
+     * @return numeric session id for the recorded keyboarding session
      */
 
     public int getSessionId() { return this.sessionId; }

src/main/java/com/studentgui/apphelpers/dto/NotesPayload.java

@@ -25,8 +25,9 @@ public NotesPayload(final int sessionIdParam, final String notesParam) {
 
     @Override
     /**
-     * getSessionId - TODO: describe this method
-     * @return TODO: describe return value
+     * Return the database session id associated with this notes payload.
+     *
+     * @return numeric session id for the recorded notes entry
      */
 
     public int getSessionId() { return this.sessionId; }

src/main/java/com/studentgui/apppages/Abacus.java

@@ -412,8 +412,14 @@ private void refreshGraph() {
     }
     @Override
     /**
-     * dateChanged - TODO: describe this method
-     * @param newDate TODO: describe parameter
+     * Update the displayed date for the Abacus page and refresh content.
+     *
+     * Records `dateParam` and schedules a UI refresh on the Swing EDT so the
+     * graph and title display the selected date. Note: some pages refresh
+     * recent sessions independent of the selected date; this call keeps the
+     * saved date in sync for subsequent actions.
+     *
+     * @param newDate the date to display (may be null to use current date)
      */
 
     public void dateChanged(final LocalDate newDate) {
@@ -427,8 +433,12 @@ public void dateChanged(final LocalDate newDate) {
 
     @Override
     /**
-     * studentChanged - TODO: describe this method
-     * @param newStudent TODO: describe parameter
+     * Update the selected student for the Abacus page and refresh content.
+     *
+     * Sets `studentNameParam` and posts a UI refresh on the Swing EDT to
+     * reload data and update the page title.
+     *
+     * @param newStudent student identifier (name or id) to display; may be null
      */
 
     public void studentChanged(final String newStudent) {

src/main/java/com/studentgui/apppages/Braille.java

@@ -422,10 +422,13 @@ private void refreshGraph() {
 
     @Override
     /**
-     * dateChanged - TODO: describe this method
-     * @param newDate TODO: describe parameter
+     * Update the displayed date for the Braille page and refresh content.
+     *
+     * Stores `dateParam` and schedules a UI refresh on the Swing EDT so the
+     * graph and title reflect the new date selection.
+     *
+     * @param newDate the date to display (may be null to use current date)
      */
-
     public void dateChanged(final LocalDate newDate) {
         this.dateParam = newDate;
         SwingUtilities.invokeLater(() -> {
@@ -436,10 +439,13 @@ public void dateChanged(final LocalDate newDate) {
 
     @Override
     /**
-     * studentChanged - TODO: describe this method
-     * @param newStudent TODO: describe parameter
+     * Update the selected student for the Braille page and refresh content.
+     *
+     * Sets `studentNameParam` and posts a refresh task to the Swing EDT to
+     * reload data and update the page title.
+     *
+     * @param newStudent student identifier (name or id) to display; may be null
      */
-
     public void studentChanged(final String newStudent) {
         this.studentNameParam = newStudent != null ? newStudent : "Unknown Student";
         SwingUtilities.invokeLater(() -> {

src/main/java/com/studentgui/apppages/BrailleNote.java

@@ -429,8 +429,12 @@ private void refreshGraph() {
 
     @Override
     /**
-     * dateChanged - TODO: describe this method
-     * @param newDate TODO: describe parameter
+     * Update the currently displayed date for this page and refresh the UI.
+     *
+     * Sets the internal `dateParam` and schedules a refresh of the graph and
+     * title on the Swing Event Dispatch Thread.
+     *
+     * @param newDate the date to display (may be null to use the current date)
      */
 
     public void dateChanged(LocalDate newDate) {
@@ -443,8 +447,12 @@ public void dateChanged(LocalDate newDate) {
 
     @Override
     /**
-     * studentChanged - TODO: describe this method
-     * @param newStudent TODO: describe parameter
+     * Update the selected student for this page and refresh the UI.
+     *
+     * Sets the internal `studentNameParam` and schedules a refresh of the
+     * graph and title on the Swing Event Dispatch Thread.
+     *
+     * @param newStudent student identifier (name or id) to display; may be null
      */
 
     public void studentChanged(String newStudent) {

src/main/java/com/studentgui/apppages/DigitalLiteracy.java

@@ -427,10 +427,14 @@ private void refreshGraph() {
     }
 
     @Override
-    /**
-     * dateChanged - TODO: describe this method
-     * @param newDate TODO: describe parameter
-     */
+        /**
+         * Update the displayed date for the Digital Literacy page and refresh UI.
+         *
+         * Records `dateParam` and schedules a UI refresh on the Swing EDT so the
+         * chart and title display the selected date.
+         *
+         * @param newDate the date to display (may be null to use current date)
+         */
 
     public void dateChanged(final LocalDate newDate) {
         this.dateParam = newDate;
@@ -441,10 +445,14 @@ public void dateChanged(final LocalDate newDate) {
     }
 
     @Override
-    /**
-     * studentChanged - TODO: describe this method
-     * @param newStudent TODO: describe parameter
-     */
+        /**
+         * Update the selected student for the Digital Literacy page and refresh UI.
+         *
+         * Sets `studentNameParam` and posts a refresh on the Swing EDT to reload
+         * data and update the page title.
+         *
+         * @param newStudent student identifier (name or id) to display; may be null
+         */
 
     public void studentChanged(final String newStudent) {
         this.studentNameParam = newStudent;

src/main/java/com/studentgui/apppages/JLineGraph.java

@@ -215,7 +215,9 @@ public JLineGraph() {
 
     @Override
     /**
-     * settingsChanged - TODO: describe this method
+     * Load chart-related preferences from the global Settings store and apply
+     * them to this graph instance. Currently this updates jitter-related
+     * configuration such as enabled/deterministic flags and the optional seed.
      */
 
     public void settingsChanged() {
@@ -839,9 +841,14 @@ private void updateXAxisLabels() {
         domain.setTickUnit(new org.jfree.chart.axis.NumberTickUnit(1) {
             @Override
             /**
-             * valueToString - TODO: describe this method
-             * @param value TODO: describe parameter
-             * @return TODO: describe return value
+             * Convert a numeric X-axis tick value into the corresponding skill
+             * label. The chart uses 1-based integer positions; this method maps
+             * that position (cast to an index) into the precomputed
+             * `skillLabels` array and returns an empty string for out-of-range
+             * values.
+             *
+             * @param value numeric tick value provided by the axis
+             * @return the skill label for the given tick, or an empty string
              */
 
             public String valueToString(double value) {

src/main/java/com/studentgui/apppages/Keyboarding.java

@@ -241,8 +241,12 @@ private void refreshGraph() {
 
     @Override
     /**
-     * dateChanged - TODO: describe this method
-     * @param newDate TODO: describe parameter
+     * Update the displayed date for the Keyboarding page and refresh content.
+     *
+     * Stores the provided `dateParam` and schedules a refresh on the Swing EDT
+     * so the UI (graph and title) reflects the new date.
+     *
+     * @param newDate the date to display (may be null to use current date)
      */
 
     public void dateChanged(LocalDate newDate) {
@@ -255,8 +259,12 @@ public void dateChanged(LocalDate newDate) {
 
     @Override
     /**
-     * studentChanged - TODO: describe this method
-     * @param newStudent TODO: describe parameter
+     * Update the selected student for the Keyboarding page and refresh content.
+     *
+     * Sets `studentNameParam` and schedules a UI update on the Swing EDT to
+     * reload page data and update the title.
+     *
+     * @param newStudent student identifier (name or id) to display; may be null
      */
 
     public void studentChanged(String newStudent) {