Browse Source

documentation

Martin Jurča 6 years ago
parent
commit
6a2c5b4de8
3 changed files with 10 additions and 0 deletions
  1. 3 0
      js/reveal.js
  2. 3 0
      plugin/notes/notes.html
  3. 4 0
      plugin/notes/notes.js

+ 3 - 0
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();

+ 3 - 0
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;

+ 4 - 0
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( {