Add JSDoc examples

kgryte · kgryte · commit c831a5d76492 · 2019-06-26T19:24:27.000-07:00
diff --git a/lib/node_modules/@stdlib/repl/presentation/lib/main.js b/lib/node_modules/@stdlib/repl/presentation/lib/main.js
@@ -670,7 +670,25 @@ setNonEnumerableReadOnly( Presentation.prototype, 'lastFragment', function lastF
 * @returns {void}
 *
 * @example
-* // TODO
+* var debug = require( '@stdlib/streams/node/debug-sink' );
+*
+* // Create a new REPL:
+* var repl = new REPL({
+*     'output': debug()
+* });
+*
+* // Create a new REPL presentation:
+* var pres = new Presentation( repl );
+*
+* // ...
+*
+* // Run any code on the current slide:
+* pres.run( done );
+*
+* function done() {
+*     // Close the REPL:
+*     repl.close();
+* }
 */
 setNonEnumerableReadOnly( Presentation.prototype, 'run', function run( clbk ) {
 	var self;
@@ -728,7 +746,29 @@ setNonEnumerableReadOnly( Presentation.prototype, 'run', function run( clbk ) {
 * @returns {Presentation} presentation instance
 *
 * @example
-* // TODO
+* var debug = require( '@stdlib/streams/node/debug-sink' );
+*
+* // Create a new REPL:
+* var repl = new REPL({
+*     'output': debug()
+* });
+*
+* // Create a new REPL presentation:
+* var pres = new Presentation( repl );
+*
+* // ...
+*
+* // Load a presentation from a file:
+* try {
+*     pres.load( './path/to/presentation/file.txt' );
+* } catch ( err ) {
+*     console.error( err.message );
+* }
+*
+* // ...
+*
+* // Close the REPL:
+* repl.close();
 */
 setNonEnumerableReadOnly( Presentation.prototype, 'load', function load( file ) {
 	file = readFile( file, {
@@ -767,7 +807,25 @@ setNonEnumerableReadOnly( Presentation.prototype, 'load', function load( file )
 * @returns {Presentation} presentation instance
 *
 * @example
-* // TODO
+* var debug = require( '@stdlib/streams/node/debug-sink' );
+*
+* // Create a new REPL:
+* var repl = new REPL({
+*     'output': debug()
+* });
+*
+* // Create a new REPL presentation:
+* var pres = new Presentation( repl );
+*
+* // ...
+*
+* // Reload a presentation:
+* pres.reload();
+*
+* // ...
+*
+* // Close the REPL:
+* repl.close();
 */
 setNonEnumerableReadOnly( Presentation.prototype, 'reload', function reload() {
 	var currentSlide = this.currentSlide;
@@ -792,7 +850,25 @@ setNonEnumerableReadOnly( Presentation.prototype, 'reload', function reload() {
 * @returns {(string|null)} rendered slide
 *
 * @example
-* // TODO
+* var debug = require( '@stdlib/streams/node/debug-sink' );
+*
+* // Create a new REPL:
+* var repl = new REPL({
+*     'output': debug()
+* });
+*
+* // Create a new REPL presentation:
+* var pres = new Presentation( repl );
+*
+* // ...
+*
+* // Render the current presentation slide:
+* var slide = pres.render();
+*
+* // ...
+*
+* // Close the REPL:
+* repl.close();
 */
 setNonEnumerableReadOnly( Presentation.prototype, 'render', function render() {
 	var paddingBottom;
@@ -882,7 +958,25 @@ setNonEnumerableReadOnly( Presentation.prototype, 'render', function render() {
 * @returns {Presentation} presentation instance
 *
 * @example
-* // TODO
+* var debug = require( '@stdlib/streams/node/debug-sink' );
+*
+* // Create a new REPL:
+* var repl = new REPL({
+*     'output': debug()
+* });
+*
+* // Create a new REPL presentation:
+* var pres = new Presentation( repl );
+*
+* // ...
+*
+* // Show a presentation slide:
+* pres.show();
+*
+* // ...
+*
+* // Close the REPL:
+* repl.close();
 */
 setNonEnumerableReadOnly( Presentation.prototype, 'show', function show() {
 	var str = this.render();
