Document encodeGlobal api

1 files changed, 15 insertions, 3 deletions

diff --git a/lib/api/encodeGlobal.js b/lib/api/encodeGlobal.js
index e8f7156..2bd5949 100644
--- a/lib/api/encodeGlobal.js
+++ b/lib/api/encodeGlobal.js
@@ -28,14 +28,29 @@ function encodeGlobal(output) {
         log: logger,
         config: encodeConfig(output, book.getConfig()),
 
+        /**
+            Check if the book is a multilingual book
+
+            @return {Boolean}
+        */
         isMultilingual: function() {
             return book.isMultilingual();
         },
 
+        /**
+            Check if the book is a language book for a multilingual book
+
+            @return {Boolean}
+        */
         isLanguageBook: function() {
             return book.isLanguageBook();
         },
 
+        /**
+            Same as isLanguageBook
+
+            @deprecated
+        */
         isSubBook: deprecate.method(output, 'this.isSubBook', function() {
             return book.isLanguageBook();
         }, '"isSubBook" is deprecated, use "isLanguageBook()" instead'),
@@ -119,9 +134,6 @@ function encodeGlobal(output) {
         }
     };
 
-    // todo
-    // template.applyBlock
-
     // Deprecated properties
 
     deprecate.field(output, 'this.generator', result, 'generator',