|
99 | 99 | html: 0, |
100 | 100 |
|
101 | 101 | /** |
102 | | - * IFrame included content |
| 102 | + * IFrame embedded content |
103 | 103 | * |
104 | 104 | * @readOnly |
105 | 105 | * @property iframe |
|
272 | 272 | loadingTemplate: "<span class=\"spinner\"></span> #text#", |
273 | 273 |
|
274 | 274 | /* |
275 | | - * Behaviours |
| 275 | + * Behaviour |
276 | 276 | */ |
277 | 277 |
|
278 | 278 | /** |
|
356 | 356 | preloadContent: false, |
357 | 357 |
|
358 | 358 | /** |
359 | | - * Shows the finish always (on each step; right beside the next button) if `true`. |
360 | | - * Otherwise the next button will be replaced by the finish on the last step. |
| 359 | + * Shows the finish button always (on each step; right beside the next button) if `true`. |
| 360 | + * Otherwise the next button will be replaced by the finish button if the last step becomes active. |
361 | 361 | * |
362 | 362 | * @property showFinishButtonAlways |
363 | 363 | * @type Boolean |
|
367 | 367 | showFinishButtonAlways: false, |
368 | 368 |
|
369 | 369 | /** |
370 | | - * Forces forward navigation (move backward is not possible). |
| 370 | + * Prevents jumping to a previous step. |
371 | 371 | * |
372 | 372 | * @property forceMoveForward |
373 | 373 | * @type Boolean |
|
398 | 398 | startIndex: 0, |
399 | 399 |
|
400 | 400 | /* |
401 | | - * Animation Effect Settings |
| 401 | + * Animation Effect Configuration |
402 | 402 | */ |
403 | 403 |
|
404 | 404 | /** |
|
422 | 422 | transitionEffectSpeed: 200, |
423 | 423 |
|
424 | 424 | /* |
425 | | - * Event Handlers |
| 425 | + * Events |
426 | 426 | */ |
427 | 427 |
|
428 | 428 | /** |
|
458 | 458 | onFinishing: function (event, currentIndex) { return true; }, |
459 | 459 |
|
460 | 460 | /** |
461 | | - * Fires after the completion. |
| 461 | + * Fires after completion. |
462 | 462 | * |
463 | 463 | * @property onFinished |
464 | 464 | * @type Event |
|
548 | 548 | * Gets the current step object. |
549 | 549 | * |
550 | 550 | * @method getCurrentStep |
551 | | - * @return {Integer} The actual step object |
| 551 | + * @return {Object} The actual step object |
552 | 552 | **/ |
553 | 553 | $.fn.steps.getCurrentStep = function () |
554 | 554 | { |
|
560 | 560 | * |
561 | 561 | * @method getStep |
562 | 562 | * @param index {Integer} An integer that belongs to the position of a step |
563 | | - * @return {Integer} A specific step object |
| 563 | + * @return {Object} A specific step object |
564 | 564 | **/ |
565 | 565 | $.fn.steps.getStep = function (index) |
566 | 566 | { |
|
609 | 609 | }; |
610 | 610 |
|
611 | 611 | /** |
612 | | - * Completes editing. |
| 612 | + * Triggers the onFinishing and onFinished event. |
613 | 613 | * |
614 | 614 | * @method finish |
615 | 615 | **/ |
|
0 commit comments