Attachment 127274 Details for Bug 29408 – Bug 29408: Begginings of JSDoc documentation

[patch] Bug 29408: Begginings of JSDoc documentation

Bug-29408-Begginings-of-JSDoc-documentation.patch (text/plain), 1.37 KB, created by Martin Renvoize (ashimema) on 2021-11-03 16:54:05 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Martin Renvoize (ashimema)

Created: 2021-11-03 16:54:05 UTC

Size: 1.37 KB

patch

obsolete

>From 26096858db12194039f13d2e48974160caff819e Mon Sep 17 00:00:00 2001
>From: Martin Renvoize <martin.renvoize@ptfs-europe.com>
>Date: Wed, 3 Nov 2021 16:52:57 +0000
>Subject: [PATCH] Bug 29408: Begginings of JSDoc documentation
>
>I'd love to see the parameters clearly documented... I've started it off
>but need some help.
>---
> koha-tmpl/intranet-tmpl/prog/js/datatables.js | 8 ++++++++
> 1 file changed, 8 insertions(+)
>
>diff --git a/koha-tmpl/intranet-tmpl/prog/js/datatables.js b/koha-tmpl/intranet-tmpl/prog/js/datatables.js
>index 09d1a0e3df..a4394b1c15 100644
>--- a/koha-tmpl/intranet-tmpl/prog/js/datatables.js
>+++ b/koha-tmpl/intranet-tmpl/prog/js/datatables.js
>@@ -517,6 +517,14 @@ jQuery.fn.dataTable.ext.errMode = function(settings, note, message) {
> 
> (function($) {
> 
>+    /**
>+    * Create a new dataTable instance that uses the Koha RESTful API's as a data source
>+    * @param  {Object}  options         Please see the dataTables documentation for further details
>+    * @param  {Object}  column_settings The arrayref as returned by KohaTables include
>+    * @param  {Boolean} add_filters     What does this actually do?
>+    * @param  {Object}  default_filters What does this actually do?
>+    * @return {Object}                  The dataTables instance
>+    */
>     $.fn.kohaTable = function(options, columns_settings, add_filters, default_filters) {
>         var settings = null;
> 
>-- 
>2.20.1

Actions: View | Diff | Splinter Review

Attachments on bug 29408: 127272 | 127273 | 127274 | 127282 | 127283 | 127284 | 127290 | 127291 | 127292 | 127313 | 127314 | 127315