Skip to content

Commit 71b01b5

Browse files
kgrytekgryte
committed
Add JSDoc examples
1 parent 262235d commit 71b01b5

File tree

1 file changed

+152
-8
lines changed
  • lib/node_modules/@stdlib/repl/presentation/lib

1 file changed

+152
-8
lines changed

‎lib/node_modules/@stdlib/repl/presentation/lib/main.js‎

Lines changed: 152 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,25 @@ setNonEnumerableReadOnly( Presentation.prototype, '_select', function select( n,
383383
* @returns {Presentation} presentation instance
384384
*
385385
* @example
386-
* // TODO
386+
* var debug = require( '@stdlib/streams/node/debug-sink' );
387+
*
388+
* // Create a new REPL:
389+
* var repl = new REPL({
390+
* 'output': debug()
391+
* });
392+
*
393+
* // Create a new REPL presentation:
394+
* var pres = new Presentation( repl );
395+
*
396+
* // ...
397+
*
398+
* // Jump to a particular slide:
399+
* pres.jumpTo( 1 );
400+
*
401+
* // ...
402+
*
403+
* // Close the REPL:
404+
* repl.close();
387405
*/
388406
setNonEnumerableReadOnly( Presentation.prototype, 'jumpTo', function jumpTo( n ) {
389407
this._select( n-1 );
@@ -400,7 +418,25 @@ setNonEnumerableReadOnly( Presentation.prototype, 'jumpTo', function jumpTo( n )
400418
* @returns {Presentation} presentation instance
401419
*
402420
* @example
403-
* // TODO
421+
* var debug = require( '@stdlib/streams/node/debug-sink' );
422+
*
423+
* // Create a new REPL:
424+
* var repl = new REPL({
425+
* 'output': debug()
426+
* });
427+
*
428+
* // Create a new REPL presentation:
429+
* var pres = new Presentation( repl );
430+
*
431+
* // ...
432+
*
433+
* // Jump to the third previous slide:
434+
* pres.jump( -3 );
435+
*
436+
* // ...
437+
*
438+
* // Close the REPL:
439+
* repl.close();
404440
*/
405441
setNonEnumerableReadOnly( Presentation.prototype, 'jump', function jump( n ) {
406442
return this.jumpTo( this.currentSlide+n );
@@ -415,7 +451,25 @@ setNonEnumerableReadOnly( Presentation.prototype, 'jump', function jump( n ) {
415451
* @returns {Presentation} presentation instance
416452
*
417453
* @example
418-
* // TODO
454+
* var debug = require( '@stdlib/streams/node/debug-sink' );
455+
*
456+
* // Create a new REPL:
457+
* var repl = new REPL({
458+
* 'output': debug()
459+
* });
460+
*
461+
* // Create a new REPL presentation:
462+
* var pres = new Presentation( repl );
463+
*
464+
* // ...
465+
*
466+
* // Move to the next slide (or fragment):
467+
* pres.next();
468+
*
469+
* // ...
470+
*
471+
* // Close the REPL:
472+
* repl.close();
419473
*/
420474
setNonEnumerableReadOnly( Presentation.prototype, 'next', function next() {
421475
var s = this._select( this._slideCursor, this._fragmentCursor+1 );
@@ -434,7 +488,25 @@ setNonEnumerableReadOnly( Presentation.prototype, 'next', function next() {
434488
* @returns {Presentation} presentation instance
435489
*
436490
* @example
437-
* // TODO
491+
* var debug = require( '@stdlib/streams/node/debug-sink' );
492+
*
493+
* // Create a new REPL:
494+
* var repl = new REPL({
495+
* 'output': debug()
496+
* });
497+
*
498+
* // Create a new REPL presentation:
499+
* var pres = new Presentation( repl );
500+
*
501+
* // ...
502+
*
503+
* // Move to the previous slide (or fragment):
504+
* pres.prev();
505+
*
506+
* // ...
507+
*
508+
* // Close the REPL:
509+
* repl.close();
438510
*/
439511
setNonEnumerableReadOnly( Presentation.prototype, 'prev', function prev() {
440512
var s = this._select( this._slideCursor, this._fragmentCursor-1 );
@@ -460,7 +532,25 @@ setNonEnumerableReadOnly( Presentation.prototype, 'prev', function prev() {
460532
* @returns {Presentation} presentation instance
461533
*
462534
* @example
463-
* // TODO
535+
* var debug = require( '@stdlib/streams/node/debug-sink' );
536+
*
537+
* // Create a new REPL:
538+
* var repl = new REPL({
539+
* 'output': debug()
540+
* });
541+
*
542+
* // Create a new REPL presentation:
543+
* var pres = new Presentation( repl );
544+
*
545+
* // ...
546+
*
547+
* // Move to the first slide:
548+
* pres.first();
549+
*
550+
* // ...
551+
*
552+
* // Close the REPL:
553+
* repl.close();
464554
*/
465555
setNonEnumerableReadOnly( Presentation.prototype, 'first', function first() {
466556
this.jumpTo( 1 );
@@ -476,7 +566,25 @@ setNonEnumerableReadOnly( Presentation.prototype, 'first', function first() {
476566
* @returns {Presentation} presentation instance
477567
*
478568
* @example
479-
* // TODO
569+
* var debug = require( '@stdlib/streams/node/debug-sink' );
570+
*
571+
* // Create a new REPL:
572+
* var repl = new REPL({
573+
* 'output': debug()
574+
* });
575+
*
576+
* // Create a new REPL presentation:
577+
* var pres = new Presentation( repl );
578+
*
579+
* // ...
580+
*
581+
* // Move to the last slide:
582+
* pres.last();
583+
*
584+
* // ...
585+
*
586+
* // Close the REPL:
587+
* repl.close();
480588
*/
481589
setNonEnumerableReadOnly( Presentation.prototype, 'last', function last() {
482590
this.jumpTo( this.length );
@@ -492,7 +600,25 @@ setNonEnumerableReadOnly( Presentation.prototype, 'last', function last() {
492600
* @returns {Presentation} presentation instance
493601
*
494602
* @example
495-
* // TODO
603+
* var debug = require( '@stdlib/streams/node/debug-sink' );
604+
*
605+
* // Create a new REPL:
606+
* var repl = new REPL({
607+
* 'output': debug()
608+
* });
609+
*
610+
* // Create a new REPL presentation:
611+
* var pres = new Presentation( repl );
612+
*
613+
* // ...
614+
*
615+
* // Jump to the first fragment of the current slide:
616+
* pres.firstFragment();
617+
*
618+
* // ...
619+
*
620+
* // Close the REPL:
621+
* repl.close();
496622
*/
497623
setNonEnumerableReadOnly( Presentation.prototype, 'firstFragment', function firstFragment() {
498624
this._select( this._slideCursor, 0 );
@@ -508,7 +634,25 @@ setNonEnumerableReadOnly( Presentation.prototype, 'firstFragment', function firs
508634
* @returns {Presentation} presentation instance
509635
*
510636
* @example
511-
* // TODO
637+
* var debug = require( '@stdlib/streams/node/debug-sink' );
638+
*
639+
* // Create a new REPL:
640+
* var repl = new REPL({
641+
* 'output': debug()
642+
* });
643+
*
644+
* // Create a new REPL presentation:
645+
* var pres = new Presentation( repl );
646+
*
647+
* // ...
648+
*
649+
* // Jump to the last fragment of the current slide:
650+
* pres.lastFragment();
651+
*
652+
* // ...
653+
*
654+
* // Close the REPL:
655+
* repl.close();
512656
*/
513657
setNonEnumerableReadOnly( Presentation.prototype, 'lastFragment', function lastFragment() {
514658
this._select( this._slideCursor, this._slide.fragments.length-1 );

0 commit comments

Comments
 (0)