From 19b980254b6ce279654874d5240bbd10ac08a886 Mon Sep 17 00:00:00 2001
From: Andrew Nicols <andrew@nicols.co.uk>
Date: Tue, 19 Oct 2021 10:36:26 +0800
Subject: [PATCH 1/1] MDL-72507 core_form: Documentation fix

---
 lib/form/amd/build/events.min.js     | Bin 3043 -> 3044 bytes
 lib/form/amd/build/events.min.js.map | Bin 14794 -> 14939 bytes
 lib/form/amd/src/events.js           |  59 +++++++++++++--------------
 3 files changed, 29 insertions(+), 30 deletions(-)

diff --git a/lib/form/amd/build/events.min.js b/lib/form/amd/build/events.min.js
index 0da5bc9f50e5de4290e274301a136fda706b0798..eca6de75d635dffeb2e6a5b520775114ab71def0 100644
GIT binary patch
delta 44
zcmV+{0Mq~D7vvX^vIcZ{aAk8nlaB`(k>^d3xDc~00nG%Fuojau3x%`#1tSHMxC<+&
Ch7rpE

delta 48
zcmV-00MGyA7vmR@vJ`G_bZKUJRd8%?VPr#SVQyz-WId6vZnHE2#{{#N1|kKM`vsem
GxeF`w;1jw4

diff --git a/lib/form/amd/build/events.min.js.map b/lib/form/amd/build/events.min.js.map
index 2ecffdd9a2127d675c024d071bbf05d83d5cb228..936ac847cad2d51c30f8a953bc0fb308a084808a 100644
GIT binary patch
delta 1106
zcmZ`&-Ahwp80Tm@H{CKw-TXYAKtbR9o^vA9`@Uz+sr#^LQW$!4$2IkAYnwWg=q9L(
z@aCca!5~67*WDHv1ziL|1VYel*Fj|Ob0jteck#UM^Lu~K@A=qsj`H6MhsP4U9ktad
zMA0{OLr)h%38=2%a4b3MwL~JYEufiHzM!Y|oH<tEm*o3IF|=$pl}_fBF~zt?`zI-h
zQZ5WJR9b{rm4BrLIJmUm)~^;ACmN+1;gkl*E~5i#lyI`a>8=^Cic~z=V$@)BWR_B-
z3KpfrV3g*W<ycT0pF<?WDEIQL^)QdGJS?=;6mkMyP6Bjd81F$Z*D+$&;&8G`=^S2n
z*aRL$6qvM_A+HSscqj-<HSHk_qf??jPB&PNlOUyGbg(F44J&n!#DzbDKpag-7?D0k
z!h($e*WlRZmVEHr=7VOtTbh6qSA&E(eC{AJPURk!$;IGJO^d8st;diu$gu7qi!#Xj
ztaAuXY^_jbZ-Ae!a#bRyRMFiC4v_RSx)2D6OPog6F^sRXZFp(-N;~kuzUH}88qG9G
zib-3u>1P8l<>-|*VAr8I(^k``CIbhK-gC$g$Jgd<cA?Oh+MCX#iu14r9^Zs(b=mO@
zBlBVjf;d$R51&cHk$)RoU%{eJ|0Zj=ln=wlx{$ODP0pexdSTiF=dhH4@6J(YK}DVa
z^((Hf@oX7VUYd`I)unw%<&(lhRIx_0^e)DW6%11Th?)M&FKo4|nVi0~mdP1?Ivh1l
zLZr0=dYaTSJP(?36+Sh3Mz*q>87;vdXz8S$kmI^8@7>x=r8i_9Kc}&h)ET1ryy=;A
zPOr)A@zhmdGBeh)BRNW;=KI#lavzS`inV%TF)ib-yAPIoy|C5R1Fzf18%kki86na#
z4GZr2+8r$~ubvibHg{~<;FoV&%ERZ*E?61O!8_Rn%h#*n&uB;0-ea<uhW+jvm3!h`
S_RH|p?=jaqlULx--~104`%3}<

delta 883
zcmZ`&OHWfl6wVY36ll?fr7huM(YDqJL9~Lz1kcPZ&}dsqDI^9TSGYh6x2?A$P*}P!
zQA0vbjQ_yL&g3R8T$s2pCT=vYOiWbb!i7sWuGE?9!m45O<(!jmzVAFT@5QU?<4+`<
z6S^ggg%AxHtA=TmL{i22!a`zACg%%PVU!FDzY%U<cEt$3CBEK^G-T?PN};q=4UL4%
z3$Q)`Gy_}$H8l|UsNo06<HN@7u9_wor#gU6IY5He7;I`8%IOM+bvw5&?Hc7^GK<r3
zfD~6G0EH$~I8Jjicgi`HCnY4}e3GUlTNQW~x10TB10OUGkrn*d+(9OA*L{#A(c>QS
z*9l&$6HMcryE8aXO$IQjWCj_X2RPwS2Ki~+aS!1KsryHZ_7*f)XQx<NHb1~%Hle1-
zL8ho4@gft*TjJz8)>;+=Q#1>Zb^6ojk~EoC@c^^%drLnlV5BwVS#^5*4JOXC_Wx7a
zX?+*8*q%Z++D1LcxZ1;*(#{p}bz9|(+*)3)d0cJNsi*$3arje;e^mm9HD_S8RN#ZS
z<w+8OFFYH8?4GtW-jl?{+umW1r8&<WF!7By5-8PG>RXHB{&wHotYTJ~?2K<pTUuq1
zU*XC~u$t3{JiI!H<VYqI|GT;xHbct{_(a9w<Q?-A)$xftR(Gqg9dEzY<X$XWX2P<{
z79Q{D!mqvvJ`V?Etl^=)fc?4SCc!KIMm*Bzx9<enTuw3;_S;W81+j;_8VDx3H}F~a
zeP5|83X3%mLZ4q&e}pgVr6mKmdJfxPddw#KXOtbl-Do#XN6z8dqfvYrvB(x?W5akU
M>cxApy9gt}U!ko9r~m)}

diff --git a/lib/form/amd/src/events.js b/lib/form/amd/src/events.js
index 5ba253733f..141b1653a7 100644
--- a/lib/form/amd/src/events.js
+++ b/lib/form/amd/src/events.js
@@ -53,9 +53,10 @@ const changesMadeCheck = e => {
  * Events for `core_form`.
  *
  * @constant
- * @property {String} formError See {@link event:formError}
- * @property {String} formFieldValidationFailed See {@link event:formFieldValidationFailed}
- * @property {String} formSubmittedByJavascript See {@link event:formSubmittedByJavascript}
+ * @property {String} formError See {@link event:core_form/error}
+ * @property {String} formFieldValidationFailed See {@link event:core_form/fieldValidationFailed}
+ * @property {String} formSubmittedByJavascript See {@link event:core_form/submittedByJavascript}
+ * @property {String} uploadChanged See {@link event:core_form/uploadChanged}
  */
 export const eventTypes = {
     /**
@@ -70,7 +71,7 @@ export const eventTypes = {
     /**
      * An event triggered when an mform is about to be submitted via javascript.
      *
-     * @event formSubmittedByJavascript
+     * @event core_form/submittedByJavascript
      * @type {CustomEvent}
      * @property {HTMLElement} target The form that was submitted
      * @property {object} detail
@@ -82,7 +83,7 @@ export const eventTypes = {
     /**
      * An event triggered upon form field validation failure.
      *
-     * @event formFieldValidationFailed
+     * @event core_form/fieldValidationFailed
      * @type {CustomEvent}
      * @property {HTMLElement} target The field that failed validation
      * @property {object} detail
@@ -93,7 +94,7 @@ export const eventTypes = {
     /**
      * An event triggered when an upload is started
      *
-     * @event uploadStarted
+     * @event core_form/uploadStarted
      * @type {CustomEvent}
      * @property {HTMLElement} target The location where the upload began
      */
@@ -102,17 +103,18 @@ export const eventTypes = {
     /**
      * An event triggered when an upload completes
      *
-     * @event uploadCompleted
+     * @event core_form/uploadCompleted
      * @type {CustomEvent}
-     * @property {HTMLElement} target The location where the upload completd
+     * @property {HTMLElement} target The location where the upload completed
      */
     uploadCompleted: 'core_form/uploadCompleted',
 
     /**
      * An event triggered when a file upload field has been changed.
      *
-     * @event notifyAttachmentChange
+     * @event core_form/uploadChanged
      * @type {CustomEvent}
+     * @property {HTMLElement} target The form field which was changed
      */
     uploadChanged: 'core_form/uploadChanged',
 };
@@ -182,6 +184,24 @@ export const notifyFieldValidationFailure = (field, message) => dispatchEvent(
     }
 );
 
+/**
+ * Trigger an event to notify the file upload field has been changed.
+ *
+ * @method
+ * @param {string} elementId The element which was changed
+ * @returns {CustomEvent}
+ * @fires uploadChanged
+ */
+export const notifyUploadChanged = elementId => dispatchEvent(
+    eventTypes.uploadChanged,
+    {},
+    document.getElementById(elementId),
+    {
+        bubbles: true,
+        cancellable: false,
+    }
+);
+
 /**
  * Trigger an event to indicate that an upload was started.
  *
@@ -320,24 +340,3 @@ if (!legacyEventsRegistered) {
 
     legacyEventsRegistered = true;
 }
-
-/**
- * Trigger an event to notify the file upload field has been changed.
- *
- * @method
- * @param {String} elementId The element which was changed
- * @returns {CustomEvent}
- * @fires uploadChanged
- */
-export const notifyUploadChanged = elementId => {
-
-    return dispatchEvent(
-        eventTypes.uploadChanged,
-        {},
-        document.getElementById(elementId),
-        {
-            bubbles: true,
-            cancellable: false,
-        }
-    );
-};
-- 
2.30.0