From 0d35f3846661f114102175f5bc1fb08ae1931150 Mon Sep 17 00:00:00 2001
From: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Date: Thu, 25 Nov 2021 11:42:17 +0000
Subject: [PATCH] Bug 29575: (QA follow-up) Add JSDoc documentation

This patch adds some basic documentation for the $patron_to_html
function the patchset introduces.

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Fridolin Somers <fridolin.somers@biblibre.com>
---
 .../intranet-tmpl/prog/en/includes/js-patron-format.inc    | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/js-patron-format.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/js-patron-format.inc
index c81d37338f..3df91d35b2 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/includes/js-patron-format.inc
+++ b/koha-tmpl/intranet-tmpl/prog/en/includes/js-patron-format.inc
@@ -1,6 +1,13 @@
 <!-- js-patron-title.inc -->
 <script>
     (function() {
+        /**
+        * Format the patron response from a Koha RESTful API request.
+        * @param  {Object}  patron  The patron json object as returned from the Koha RESTful API
+        * @param  {Object}  config  A configuration object
+        *                           Valid keys are: `invert_name`, `display_cardnumber` and `url`
+        * @return {string}          The formatted HTML string
+        */
         window.$patron_to_html = function( patron, config ) {
 
             if ( patron === undefined ) {
-- 
2.39.5