Skip to content

Commit ae11286

Browse files
l-linl-lin
committed
Correct comments
1 parent 0764e07 commit ae11286

File tree

2 files changed

+55
-56
lines changed

2 files changed

+55
-56
lines changed

‎dist/angular-datatables.js

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@
210210
/**
211211
* Set the default language source for all datatables
212212
* @param sLanguageSource the language source
213-
* @return {$DTDefaultOption} the default option config
213+
* @returns {$DTDefaultOption} the default option config
214214
*/
215215
this.setLanguageSource = function (sLanguageSource) {
216216
$.extend($.fn.dataTable.defaults, { oLanguage: { sUrl: sLanguageSource } });
@@ -219,7 +219,7 @@
219219
/**
220220
* Set the default number of items to display for all datatables
221221
* @param iDisplayLength the number of items to display
222-
* @return {$DTDefaultOption} the default option config
222+
* @returns {$DTDefaultOption} the default option config
223223
*/
224224
this.setDisplayLength = function (iDisplayLength) {
225225
$.extend($.fn.dataTable.defaults, { iDisplayLength: iDisplayLength });
@@ -243,14 +243,14 @@
243243
this.obj = obj;
244244
/**
245245
* Check if the wrapped object is defined
246-
* @return true if the wrapped object is defined, false otherwise
246+
* @returns true if the wrapped object is defined, false otherwise
247247
*/
248248
this.isPresent = function () {
249249
return angular.isDefined(this.obj) && this.obj !== null;
250250
};
251251
/**
252252
* Return the wrapped object or an empty object
253-
* @return the wrapped objector an empty object
253+
* @returns the wrapped objector an empty object
254254
*/
255255
this.orEmptyObj = function () {
256256
if (this.isPresent()) {
@@ -260,7 +260,7 @@
260260
};
261261
/**
262262
* Return the wrapped object or the given second choice
263-
* @return the wrapped object or the given second choice
263+
* @returns the wrapped object or the given second choice
264264
*/
265265
this.or = function (secondChoice) {
266266
if (this.isPresent()) {
@@ -272,7 +272,7 @@
272272
/**
273273
* Wrap the given objec
274274
* @param obj the object to wrap
275-
* @return {Optional} the optional of the wrapped object
275+
* @returns {Optional} the optional of the wrapped object
276276
*/
277277
var fromNullable = function (obj) {
278278
return new Optional(obj);
@@ -281,7 +281,7 @@
281281
* Add the option to the datatables optoins
282282
* @param key the key of the option
283283
* @param value an object or a function of the option
284-
* @return {DTOption} the options
284+
* @returns {DTOptions} the options
285285
*/
286286
this.withOption = function (key, value) {
287287
if (angular.isString(key)) {
@@ -293,7 +293,7 @@
293293
* Add the Ajax source to the options.
294294
* This corresponds to the "sAjaxSource" option
295295
* @param sAjaxSource the ajax source
296-
* @return {DTOption} the options
296+
* @returns {DTOptions} the options
297297
*/
298298
this.withSource = function (sAjaxSource) {
299299
this.sAjaxSource = sAjaxSource;
@@ -302,7 +302,7 @@
302302
/**
303303
* Add the ajax data properties.
304304
* @param sAjaxDataProp the ajax data property
305-
* @return {DTOption} the options
305+
* @returns {DTOptions} the options
306306
*/
307307
this.withDataProp = function (sAjaxDataProp) {
308308
this.sAjaxDataProp = sAjaxDataProp;
@@ -311,7 +311,7 @@
311311
/**
312312
* Set the server data function.
313313
* @param fn the function of the server retrieval
314-
* @return {DTOption} the options
314+
* @returns {DTOptions} the options
315315
*/
316316
this.withFnServerData = function (fn) {
317317
if (!angular.isFunction(fn)) {
@@ -323,7 +323,7 @@
323323
/**
324324
* Set the pagination type.
325325
* @param sPaginationType the pagination type
326-
* @return {DTOption} the options
326+
* @returns {DTOptions} the options
327327
*/
328328
this.withPaginationType = function (sPaginationType) {
329329
if (angular.isString(sPaginationType)) {
@@ -336,7 +336,7 @@
336336
/**
337337
* Set the language of the datatables
338338
* @param oLanguage the language
339-
* @return {DTOption} the options
339+
* @returns {DTOptions} the options
340340
*/
341341
this.withLanguage = function (oLanguage) {
342342
this.oLanguage = oLanguage;
@@ -345,15 +345,15 @@
345345
/**
346346
* Set the language source
347347
* @param sLanguageSource the language source
348-
* @return {DTOption} the options
348+
* @returns {DTOptions} the options
349349
*/
350350
this.withLanguageSource = function (sLanguageSource) {
351351
return this.withLanguage({ sUrl: sLanguageSource });
352352
};
353353
/**
354354
* Set default number of items per page to display
355355
* @param iDisplayLength the number of items per page
356-
* @return {DTOption} the options
356+
* @returns {DTOptions} the options
357357
*/
358358
this.withDisplayLength = function (iDisplayLength) {
359359
this.iDisplayLength = iDisplayLength;
@@ -363,7 +363,7 @@
363363
// See http://getbootstrap.com
364364
/**
365365
* Add bootstrap compatibility
366-
* @return {DTOption} the options
366+
* @returns {DTOptions} the options
367367
*/
368368
this.withBootstrap = function () {
369369
$DTBootstrap.integrate(this);
@@ -386,7 +386,7 @@
386386
};
387387
/**
388388
* Add colReorder compatibility
389-
* @return {DTOption} the options
389+
* @returns {DTOptions} the options
390390
*/
391391
this.withColReorder = function () {
392392
var colReorderPrefix = 'R';
@@ -396,7 +396,7 @@
396396
/**
397397
* Set the default column order
398398
* @param aiOrder the column order
399-
* @return {DTOption} the options
399+
* @returns {DTOptions} the options
400400
*/
401401
this.withColOrder = function (aiOrder) {
402402
if (angular.isArray(aiOrder)) {
@@ -410,7 +410,7 @@
410410
/**
411411
* Set the reorder callback function
412412
* @param fnReorderCallback
413-
* @return {DTOptions} the options
413+
* @returns {DTOptions} the options
414414
*/
415415
this.withReorderCallback = function (fnReorderCallback) {
416416
if (angular.isFunction(fnReorderCallback)) {
@@ -427,7 +427,7 @@
427427
* Add option to "oColVis" option
428428
* @param key the key of the option to add
429429
* @param value an object or a function of the function
430-
* @param {DTOption} the options
430+
* @returns {DTOptions} the options
431431
*/
432432
this.withColVisOption = function (key, value) {
433433
if (angular.isString(key)) {
@@ -438,7 +438,7 @@
438438
};
439439
/**
440440
* Add colVis compatibility
441-
* @return {DTOption} the options
441+
* @returns {DTOptions} the options
442442
*/
443443
this.withColVis = function () {
444444
var colVisPrefix = 'C<"clear">';
@@ -471,7 +471,7 @@
471471
* Add the option of the column
472472
* @param key the key of the option
473473
* @param value an object or a function of the option
474-
* @return {DTColumn} the wrapped datatables column
474+
* @returns {DTColumn} the wrapped datatables column
475475
*/
476476
this.withOption = function (key, value) {
477477
if (angular.isString(key)) {
@@ -482,7 +482,7 @@
482482
/**
483483
* Set the label of the colum
484484
* @param label the label of the column
485-
* @return {DTColumn} the wrapped datatables column
485+
* @returns {DTColumn} the wrapped datatables column
486486
*/
487487
this.withLabel = function (label) {
488488
this.label = label;
@@ -491,23 +491,23 @@
491491
/**
492492
* Set the CSS class of the column
493493
* @param sClass the CSS class
494-
* @return {DTColumn} the wrapped datatables column
494+
* @returns {DTColumn} the wrapped datatables column
495495
*/
496496
this.withClass = function (sClass) {
497497
this.sClass = sClass;
498498
return this;
499499
};
500500
/**
501501
* Hide the column
502-
* @return {DTColumn} the wrapped datatables column
502+
* @returns {DTColumn} the wrapped datatables column
503503
*/
504504
this.notVisible = function () {
505505
this.bVisible = false;
506506
return this;
507507
};
508508
/**
509509
* Set the column as not sortable
510-
* @return {DTColumn} the wrapped datatables column
510+
* @returns {DTColumn} the wrapped datatables column
511511
*/
512512
this.notSortable = function () {
513513
this.bSortable = false;
@@ -516,7 +516,7 @@
516516
/**
517517
* Render each cell with the given parameter
518518
* @mRender mRender the function/string to render the data
519-
* @return {DTColumn} the wrapped datatables column
519+
* @returns {DTColumn} the wrapped datatables column
520520
*/
521521
this.renderWith = function (mRender) {
522522
this.mRender = mRender;

0 commit comments

Comments
 (0)