From 6a2c5b4de833c73f656945253e7b72e31870c88a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Jur=C4=8Da?= Date: Tue, 20 Feb 2018 10:30:56 +0100 Subject: [PATCH] documentation --- js/reveal.js | 3 +++ plugin/notes/notes.html | 3 +++ plugin/notes/notes.js | 4 ++++ 3 files changed, 10 insertions(+) diff --git a/js/reveal.js b/js/reveal.js index 091372e1..9a1422fb 100644 --- a/js/reveal.js +++ b/js/reveal.js @@ -3901,6 +3901,9 @@ } + /** + * Returns an array of objects where each object represents the attributes on its respective slide. + */ function getSlidesMetaInfo() { var slides = getSlides(); diff --git a/plugin/notes/notes.html b/plugin/notes/notes.html index eff12750..a6bd5e2d 100644 --- a/plugin/notes/notes.html +++ b/plugin/notes/notes.html @@ -378,6 +378,9 @@ } ); + /** + * Asynchronously calls the Reveal.js API of the main frame. + */ function callRevealApi( methodName, methodArguments, callback ) { var callId = ++lastRevealApiCallId; pendingCalls[callId] = callback; diff --git a/plugin/notes/notes.js b/plugin/notes/notes.js index dd7df8ec..dce9b4eb 100644 --- a/plugin/notes/notes.js +++ b/plugin/notes/notes.js @@ -51,6 +51,10 @@ var RevealNotes = (function() { } ); } + /** + * Calls the specified Reveal.js method with the provided argument and then pushes the result to the notes + * frame. + */ function callRevealApi( methodName, methodArguments, callId ) { var result = Reveal[methodName].call(Reveal, methodArguments); notesPopup.postMessage( JSON.stringify( {