gitea
/
Koha-clms
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
This commit is contained in:
Martin Renvoize 2021-11-03 16:52:57 +00:00 committed by Jonathan Druart
parent 030db7cc8d
commit de75673d8a
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
koha-tmpl/intranet-tmpl/prog/js/datatables.js
View File

@ -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;