chore: add some jsdoc to explicit types

1024pix · Nov 6, 2024 · 293d7aa · 293d7aa
1 parent 366eef3
commit 293d7aa
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/api/src/certification/scoring/domain/models/CertificationAssessmentHistory.js b/api/src/certification/scoring/domain/models/CertificationAssessmentHistory.js
@@ -1,10 +1,20 @@
+/**
+ * @typedef {import('../../../flash-certification/domain/models/FlashAssessmentAlgorithm.js').FlashAssessmentAlgorithm} FlashAssessmentAlgorithm
+ * @typedef {import('./CertificationChallengeForScoring.js').CertificationChallengeForScoring} CertificationChallengeForScoring
+ * @typedef {import('../../../../evaluation/domain/models/Answer.js').Answer} Answer
+ */
 import { CertificationChallengeCapacity } from './CertificationChallengeCapacity.js';
 
 export class CertificationAssessmentHistory {
   constructor({ capacityHistory }) {
     this.capacityHistory = capacityHistory;
   }
-  // WARN: challenges are not Array<Challenge> but Array<CertificationChallengeForScoring>
+  /**
+   * @param {Object} params
+   * @param {FlashAssessmentAlgorithm } params.algorithm
+   * @param {Array<CertificationChallengeForScoring>} params.challenges
+   * @param {Array<Answer>} params.allAnswers
+   **/
   static fromChallengesAndAnswers({ algorithm, challenges, allAnswers }) {
     const capacityAndErrorRateHistory = algorithm.getCapacityAndErrorRateHistory({
       allAnswers,