Attachment 127315 Details for Bug 29408 – Bug 29408: Add JSDoc documentation for kohaTable function

[patch] Bug 29408: Add JSDoc documentation for kohaTable function

Bug-29408-Add-JSDoc-documentation-for-kohaTable-fu.patch (text/plain), 1.98 KB, created by Martin Renvoize (ashimema) on 2021-11-04 12:10:33 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Martin Renvoize (ashimema)

Created: 2021-11-04 12:10:33 UTC

Size: 1.98 KB

patch

obsolete

>From 801c219c99356248e999ec47d9b6d883041a2c22 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: Add JSDoc documentation for kohaTable function
>
>This patch adds some JSDoc formatted parameter documentation for the
>kohaTable function.
>
>Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
>Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
>---
> koha-tmpl/intranet-tmpl/prog/js/datatables.js | 12 ++++++++++++
> 1 file changed, 12 insertions(+)
>
>diff --git a/koha-tmpl/intranet-tmpl/prog/js/datatables.js b/koha-tmpl/intranet-tmpl/prog/js/datatables.js
>index 09d1a0e3df..bae315cf04 100644
>--- a/koha-tmpl/intranet-tmpl/prog/js/datatables.js
>+++ b/koha-tmpl/intranet-tmpl/prog/js/datatables.js
>@@ -517,6 +517,18 @@ jQuery.fn.dataTable.ext.errMode = function(settings, note, message) {
> 
> (function($) {
> 
>+    /**
>+    * Create a new dataTables instance that uses the Koha RESTful API's as a data source
>+    * @param  {Object}  options         Please see the dataTables documentation for further details
>+    *                                   We extend the options set with the `criteria` key which allows
>+    *                                   the developer to select the match type to be applied during searches
>+    *                                   Valid keys are: `contains`, `starts_with`, `ends_with` and `exact`
>+    * @param  {Object}  column_settings The arrayref as returned by TableSettings.GetColums function available
>+    *                                   from the columns_settings template toolkit include
>+    * @param  {Boolean} add_filters     Add a filters row as the top row of the table
>+    * @param  {Object}  default_filters Add a set of default search filters to apply at table initialisation
>+    * @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