Commenting

Controller.js

@@ -14,6 +14,12 @@
     /** @namespace jsOMS.Modules.Navigation.Models */
     jsOMS.Autoloader.defineNamespace('jsOMS.Modules.Navigation');
 
+    /**
+     * Constructor
+     *
+     * @since 1.0.0
+     * @author Dennis Eichhorn <d.eichhorn@oms.com>
+     */
     jsOMS.Modules.Navigation = function ()
     {
         this.navigation = {};
@@ -21,8 +27,24 @@
         this.rawNavData = this.rawNavData !== null ? this.rawNavData : {};
     };
 
+    /**
+     * Module id
+     *
+     * @var {string}
+     * @since 1.0.0
+     */
     jsOMS.Modules.Navigation.MODULE_NAME = '1000500001';
 
+    /**
+     * Bind navigation
+     *
+     * @param {string} id Navigation to bind (optional)
+     *
+     * @return {void}
+     *
+     * @since 1.0.0
+     * @author Dennis Eichhorn <d.eichhorn@oms.com>
+     */
     jsOMS.Modules.Navigation.prototype.bind = function (id)
     {
         let e      = typeof id === 'undefined' ? document.getElementsByClassName('nav') : [document.getElementById(id)],
@@ -33,9 +55,19 @@
         }
     };
 
+    /**
+     * Bind navigation element
+     *
+     * @param {Element} e Element to bind
+     *
+     * @return {void}
+     *
+     * @since 1.0.0
+     * @author Dennis Eichhorn <d.eichhorn@oms.com>
+     */
     jsOMS.Modules.Navigation.prototype.bindElement = function (e)
     {
-        if (typeof e === 'undefined') {
+        if (typeof e === 'undefined' || !e) {
             // todo: do logging here
 
             return;

Models/Navigation.js

@@ -14,6 +14,14 @@
     /** @namespace jsOMS.Modules.Navigation.Models */
     jsOMS.Autoloader.defineNamespace('jsOMS.Modules.Navigation.Models');
 
+    /**
+     * Construct
+     *
+     * @param {Object} data Initialization (optional)
+     *
+     * @since 1.0.0
+     * @author Dennis Eichhorn <d.eichhorn@oms.com>
+     */
     jsOMS.Modules.Navigation.Models.Navigation = function (data)
     {
         if (typeof data === 'undefined') {
@@ -29,27 +37,74 @@
         }
     };
 
+    /**
+     * Set scroll position
+     *
+     * @param {int} x Horizontal position
+     * @param {int} y Vertical position
+     *
+     * @return {void}
+     *
+     * @since 1.0.0
+     * @author Dennis Eichhorn <d.eichhorn@oms.com>
+     */
     jsOMS.Modules.Navigation.Models.Navigation.prototype.setScrollPosition = function (x, y)
     {
         this.scrollPosition.x = x;
         this.scrollPosition.y = y;
     };
 
+    /**
+     * Get scroll position
+     *
+     * @return {Object}
+     *
+     * @since 1.0.0
+     * @author Dennis Eichhorn <d.eichhorn@oms.com>
+     */
     jsOMS.Modules.Navigation.Models.Navigation.prototype.getScrollPosition = function ()
     {
         return this.scrollPosition;
     };
 
+    /**
+     * Open navigation category
+     *
+     * @param {string} id Category id
+     *
+     * @return {void}
+     *
+     * @since 1.0.0
+     * @author Dennis Eichhorn <d.eichhorn@oms.com>
+     */
     jsOMS.Modules.Navigation.Models.Navigation.prototype.setOpen = function (id)
     {
         this.openCategories[id] = true;
     };
 
+    /**
+     * Close navigation category
+     *
+     * @param {string} id Category id
+     *
+     * @return {void}
+     *
+     * @since 1.0.0
+     * @author Dennis Eichhorn <d.eichhorn@oms.com>
+     */
     jsOMS.Modules.Navigation.Models.Navigation.prototype.setClose = function (id)
     {
         delete this.openCategories[id];
     };
 
+    /**
+     * Get open navigation elements
+     *
+     * @return {Object}
+     *
+     * @since 1.0.0
+     * @author Dennis Eichhorn <d.eichhorn@oms.com>
+     */
     jsOMS.Modules.Navigation.Models.Navigation.prototype.getOpen = function ()
     {
         return this.openCategories;
@@ -69,33 +124,31 @@
     {
     };
 
+    /**
+     * Set navigation visibility
+     *
+     * @param {bool} visible Visibility
+     *
+     * @return {bool}
+     *
+     * @since 1.0.0
+     * @author Dennis Eichhorn <d.eichhorn@oms.com>
+     */
     jsOMS.Modules.Navigation.Models.Navigation.prototype.setVisible = function (visible)
     {
         this.visible = visible;
     };
 
+    /**
+     * Is navigation visible
+     *
+     * @return {bool}
+     *
+     * @since 1.0.0
+     * @author Dennis Eichhorn <d.eichhorn@oms.com>
+     */
     jsOMS.Modules.Navigation.Models.Navigation.prototype.isVisible = function ()
     {
         return this.visible;
     };
-
-    jsOMS.Modules.Navigation.Models.Navigation.prototype.serialize = function ()
-    {
-        return JSON.stringify({
-            visible: this.visible,
-            activeLinks: this.activeLinks,
-            scrollPosition: this.scrollPosition,
-            openCategories: this.openCategories
-        });
-    };
-
-    jsOMS.Modules.Navigation.Models.Navigation.prototype.unserialize = function (data)
-    {
-        let temp = JSON.parse(data);
-
-        this.visible        = temp.visible;
-        this.activeLinks    = temp.activeLinks;
-        this.openCategories = temp.openCategories;
-        this.scrollPosition = temp.scrollPosition;
-    };
 }(window.jsOMS = window.jsOMS || {}));