rooty/DataTables
1
0
Fork 0
mirror of https://github.com/DataTables/DataTables.git synced 2025-02-18 16:54:14 +01:00
Code Issues Releases Activity

Docs: The options (properties) for the DataTables initialisation object that have a default function need an @member tag otherwise they are documented as methods, which they are not.

Browse Source
This commit is contained in:
Allan Jardine 2012-02-01 09:07:52 +00:00
parent 62e5221184
commit a3398d9b00
3 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
media/js/jquery.dataTables.js vendored
View File

@ -8163,6 +8163,7 @@
* rendered as "1,000,000") to help readability for the end user. This
* function will override the default method DataTables uses.
* @type function
* @member
* @param {int} iIn number to be formatted
* @returns {string} formatted string for DataTables to show the number
* @dtopt Callbacks
@ -8348,6 +8349,7 @@
* application. For example you could use POST data, or pull information from
* a Gears or AIR database.
* @type function
* @member
* @param {string} sSource HTTP source to obtain the data from (sAjaxSource)
* @param {array} aoData A key/value pair object containing the data to send
* to the server
@ -8434,6 +8436,7 @@
* state of a table is loaded. By default DataTables will load from its state saving
* cookie, but you might wish to use local storage (HTML5) or a server-side database.
* @type function
* @member
* @param {object} oSettings DataTables settings object
* @return {object} The DataTables state object to be loaded
* @dtopt Callbacks
@ -8536,6 +8539,7 @@
* information for the table is stored - by default it will use a cookie, but you
* might want to use local storage (HTML5) or a server-side database.
* @type function
* @member
* @param {object} oSettings DataTables settings object
* @param {object} oData The state object to be saved
* @dtopt Callbacks
@ -10959,9 +10963,11 @@
* Extension object for DataTables that is used to provide all extension options.
* See {@link DataTable.models.ext} for full information about the extension object.
*
* Note that the <i>DataTable.ext</i> object is aliased to <i>jQuery.fn.dataTableExt</i>
* through which it may be accessed and manipulated, or <i>jQuery.fn.dataTable.ext</i>.
* Note that the <i>DataTable.ext</i> object is available through
* <i>jQuery.fn.dataTable.ext</i> where it may be accessed and manipulated. It is
* also aliased to <i>jQuery.fn.dataTableExt</i> for historic reasons.
* @namespace
* @extends DataTable.models.ext
*/
DataTable.ext = $.extend( true, {}, DataTable.models.ext );

6
media/src/DataTables.js
View File

@ -125,9 +125,11 @@
* Extension object for DataTables that is used to provide all extension options.
* See {@link DataTable.models.ext} for full information about the extension object.
*
* Note that the <i>DataTable.ext</i> object is aliased to <i>jQuery.fn.dataTableExt</i>
* through which it may be accessed and manipulated, or <i>jQuery.fn.dataTable.ext</i>.
* Note that the <i>DataTable.ext</i> object is available through
* <i>jQuery.fn.dataTable.ext</i> where it may be accessed and manipulated. It is
* also aliased to <i>jQuery.fn.dataTableExt</i> for historic reasons.
* @namespace
* @extends DataTable.models.ext
*/
DataTable.ext = $.extend( true, {}, DataTable.models.ext );
require('ext.classes.js');

4
media/src/model/model.defaults.js
View File

@ -697,6 +697,7 @@ DataTable.defaults = {
* rendered as "1,000,000") to help readability for the end user. This
* function will override the default method DataTables uses.
* @type function
* @member
* @param {int} iIn number to be formatted
* @returns {string} formatted string for DataTables to show the number
* @dtopt Callbacks
@ -882,6 +883,7 @@ DataTable.defaults = {
* application. For example you could use POST data, or pull information from
* a Gears or AIR database.
* @type function
* @member
* @param {string} sSource HTTP source to obtain the data from (sAjaxSource)
* @param {array} aoData A key/value pair object containing the data to send
* to the server
@ -968,6 +970,7 @@ DataTable.defaults = {
* state of a table is loaded. By default DataTables will load from its state saving
* cookie, but you might wish to use local storage (HTML5) or a server-side database.
* @type function
* @member
* @param {object} oSettings DataTables settings object
* @return {object} The DataTables state object to be loaded
* @dtopt Callbacks
@ -1070,6 +1073,7 @@ DataTable.defaults = {
* information for the table is stored - by default it will use a cookie, but you
* might want to use local storage (HTML5) or a server-side database.
* @type function
* @member
* @param {object} oSettings DataTables settings object
* @param {object} oData The state object to be saved
* @dtopt Callbacks