From 3e02747e1b7331d236b673fc0b9d458a5b124495 Mon Sep 17 00:00:00 2001 From: coderaiser Date: Thu, 15 Nov 2012 09:23:45 -0500 Subject: [PATCH] setted up comments --- lib/client/dom.js | 213 +++++++++++++++++++++++++++++++++------------ lib/server/rest.js | 6 +- lib/util.js | 6 +- server.js | 4 +- 4 files changed, 165 insertions(+), 64 deletions(-) diff --git a/lib/client/dom.js b/lib/client/dom.js index 5696dc2f..fc887b25 100644 --- a/lib/client/dom.js +++ b/lib/client/dom.js @@ -7,6 +7,7 @@ var CloudCommander, $, Util, DOM, CloudFunc; /* PRIVATE */ + function getCurrentFile(){ return CloudCommander.CURRENT_FILE; } @@ -52,7 +53,12 @@ var CloudCommander, $, Util, DOM, CloudFunc; } }; - DOM.addClass = function(pElement, pClass){ + /** + * add class to current element + * @param pElement + * @param pClass + */ + DOM.addClass = function(pElement, pClass){ var lRet_b = true; var lClassList = pElement.classList; @@ -71,6 +77,7 @@ var CloudCommander, $, Util, DOM, CloudFunc; * @param pType * @param pListener * @param pUseCapture + * @param pElement {document by default} */ DOM.addListener = function(pType, pListener, pUseCapture, pElement){ return (pElement || document).addEventListener( @@ -82,7 +89,6 @@ var CloudCommander, $, Util, DOM, CloudFunc; /** * safe add event keydown listener - * @param pType * @param pListener * @param pUseCapture */ @@ -90,7 +96,9 @@ var CloudCommander, $, Util, DOM, CloudFunc; return DOM.addListener('keydown', pListener, pUseCapture); }; - /* Load file countent thrue ajax */ + /** + * load file countent thrue ajax + */ DOM.ajax = function(pParams){ /* if on webkit */ if(!XMLHTTP) @@ -141,10 +149,11 @@ var CloudCommander, $, Util, DOM, CloudFunc; }; }; - /* + /** * Function gets id by src - * from http://domain.com/1.js to - * 1_js + * @param pSrc + * + * Example: http://domain.com/1.js -> 1_js */ DOM.getIdBySrc = function(pSrc){ var lID = pSrc.replace(pSrc.substr(pSrc, @@ -159,6 +168,13 @@ var CloudCommander, $, Util, DOM, CloudFunc; }, + /** + * create elements and load them to DOM-tree + * one-by-one + * + * @param pParams_a + * @param pFunc - onload function + */ DOM.anyLoadOnLoad = function(pParams_a, pFunc){ if( Util.isArray(pParams_a) ) { var lParam = pParams_a.pop(); @@ -180,20 +196,24 @@ var CloudCommander, $, Util, DOM, CloudFunc; }; /** - * Функция создаёт элемент и - * загружает файл с src. - * @pName - название тэга - * @pSrc - путь к файлу - * @pFunc - обьект, содержаий одну из функций - * или сразу две onload и onerror - * {onload: function(){}, onerror: function();} - * @pStyle - стиль - * @pId - id - * @pElement - элемент, дочерним которо будет этот - * @param pParams_o = {name: '', src: ' ',func: '', style: '', id: '', parent: '', - async: false, inner: 'id{color:red, }, class:'', not_append: false} + * Функция создаёт элемент и загружает файл с src. + * + * @param pParams_o = { + * name, - название тэга + * src', - путь к файлу + * func, - обьект, содержаий одну из функций + * или сразу две onload и onerror + * {onload: function(){}, onerror: function();} + * style, + * id, + * element, + * async, - true by default + * inner: 'id{color:red, }, + * class, + * not_append - false by default + * } */ - DOM.anyload = function(pParams_o){ + DOM.anyload = function(pParams_o){ if( !pParams_o ) return; @@ -317,8 +337,13 @@ var CloudCommander, $, Util, DOM, CloudFunc; return element; }, - /* Функция загружает js-файл */ - DOM.jsload = function(pSrc, pFunc){ + /** + * Функция загружает js-файл + * + * @param pSrc + * @param pFunc + */ + DOM.jsload = function(pSrc, pFunc){ if(pSrc instanceof Array){ for(var i=0; i < pSrc.length; i++) pSrc[i].name = 'script'; @@ -333,25 +358,26 @@ var CloudCommander, $, Util, DOM, CloudFunc; }); }, - /* Функция создаёт елемент style и записывает туда стили - * @pParams_o - структура параметров, заполняеться таким + /** + * Функция создаёт елемент style и записывает туда стили + * @param pParams_o - структура параметров, заполняеться таким * образом: {src: ' ',func: '', id: '', element: '', inner: ''} * все параметры опциональны - */ - - DOM.cssSet = function(pParams_o){ + */ + DOM.cssSet = function(pParams_o){ pParams_o.name = 'style'; pParams_o.parent = pParams_o.parent || document.head; return DOM.anyload(pParams_o); }, - /* Function loads external css files + /** + * Function loads external css files * @pParams_o - структура параметров, заполняеться таким * образом: {src: ' ',func: '', id: '', element: '', inner: ''} * все параметры опциональны */ - DOM.cssLoad = function(pParams_o){ + DOM.cssLoad = function(pParams_o){ if( Util.isArray(pParams_o) ){ for(var i = 0, n = pParams_o.length; i < n; i++){ pParams_o[i].name = 'link'; @@ -370,7 +396,11 @@ var CloudCommander, $, Util, DOM, CloudFunc; return DOM.anyload(pParams_o); }; - DOM.jqueryLoad = function(pCallBack){ + /** + * load jquery from google cdn or local copy + * @param pCallBack + */ + DOM.jqueryLoad = function(pCallBack){ /* загружаем jquery: */ DOM.jsload('//ajax.googleapis.com/ajax/libs/jquery/1.8.0/jquery.min.js',{ onload: Util.retExec(pCallBack), @@ -394,7 +424,11 @@ var CloudCommander, $, Util, DOM, CloudFunc; }); }; - DOM.socketLoad = function(pCallBack){ + /** + * load socket.io + * @param pCallBack + */ + DOM.socketLoad = function(pCallBack){ DOM.jsload('lib/client/socket.js', pCallBack); }; @@ -402,17 +436,17 @@ var CloudCommander, $, Util, DOM, CloudFunc; /** * Function search element by tag - * @pTag - className - * @pElement - element + * @param pTag - className + * @param pElement - element */ - DOM.getByTag = function(pTag, pElement){ + DOM.getByTag = function(pTag, pElement){ return (pElement || document).getElementsByTagName(pTag); }; /** * Function search element by id - * @Id - className - * @pElement - element + * @param Id - className + * @param pElement - element */ DOM.getById = function(pId, pElement){ return (pElement || document).getElementById(pId); @@ -420,18 +454,17 @@ var CloudCommander, $, Util, DOM, CloudFunc; /** * Function search element by class name - * @pClass - className - * @pElement - element + * @param pClass - className + * @param pElement - element */ - DOM.getByClass = function(pClass, pElement){ + DOM.getByClass = function(pClass, pElement){ return (pElement || document).getElementsByClassName(pClass); }; - DOM.Images = { - /* + DOM.Images = { + /** * Function shows loading spinner - * @pElem - top element of screen * pPosition = {top: true}; */ showLoad : function(pPosition){ @@ -474,11 +507,17 @@ var CloudCommander, $, Util, DOM, CloudFunc; return lRet_b; }, + /** + * hide load image + */ hideLoad : function(){ LoadingImage = Images_o.loading(); DOM.hide(LoadingImage); }, + /** + * show error image (usualy after error on ajax request) + */ showError : function(jqXHR, textStatus, errorThrown){ LoadingImage = Images_o.loading(); @@ -511,6 +550,9 @@ var CloudCommander, $, Util, DOM, CloudFunc; } }; + /** + * unified way to get current file + */ DOM.getCurrentFile = function(){ var lCurrent = DOM.getByClass(getCurrentFile())[0]; if(!lCurrent) @@ -524,6 +566,10 @@ var CloudCommander, $, Util, DOM, CloudFunc; return lCurrent; }; + + /** + * unified way to get RefreshButton + */ DOM.getRefreshButton = function(){ var lPanel = DOM.getPanel(), lRefresh = DOM.getByClass(CloudFunc.REFRESHICON, lPanel); @@ -541,6 +587,9 @@ var CloudCommander, $, Util, DOM, CloudFunc; return lRefresh; }; + /** + * unified way to set current file + */ DOM.setCurrentFile = function(pCurrentFile){ var lRet_b = true; @@ -574,12 +623,16 @@ var CloudCommander, $, Util, DOM, CloudFunc; }; /** - * set onclick handler on button f1-f10 + * set onclick handler on buttons f1-f10 + * @param pKey - 'f1'-'f10' */ DOM.setButtonKey = function(pKey, pFunc){ return CloudCommander.KeysPanel[pKey].onclick = pFunc; }; + /** + * private function thet unset currentfile + */ var lUnSetCurrentFile = function(pCurrentFile){ if(!pCurrentFile) DOM.addCloudStatus({ @@ -597,6 +650,11 @@ var CloudCommander, $, Util, DOM, CloudFunc; return lRet_b; }; + /** + * current file check + * + * @param pCurrentFile + */ DOM.isCurrentFile = function(pCurrentFile){ if(!pCurrentFile) DOM.addCloudStatus({ @@ -613,7 +671,12 @@ var CloudCommander, $, Util, DOM, CloudFunc; }; - DOM.getCurrentLink = function(pCurrentFile){ + /** + * get link from current (or param) file + * + * @param pCurrentFile - current file by default + */ + DOM.getCurrentLink = function(pCurrentFile){ var lLink = DOM.getByTag('a', pCurrentFile || DOM.getCurrentFile()), @@ -628,7 +691,12 @@ var CloudCommander, $, Util, DOM, CloudFunc; return lRet; }; - DOM.getCurrentName = function(pCurrentFile){ + /** + * get name from current (or param) file + * + * @param pCurrentFile + */ + DOM.getCurrentName = function(pCurrentFile){ var lLink = DOM.getCurrentLink( pCurrentFile || DOM.getCurrentFile()); @@ -645,14 +713,14 @@ var CloudCommander, $, Util, DOM, CloudFunc; /** function getting FM * @param pPanel_o = {active: true} */ - DOM.getFM = function(){ + DOM.getFM = function(){ return DOM.getPanel().parentElement; }; /** function getting panel active, or passive * @param pPanel_o = {active: true} */ - DOM.getPanel = function(pActive){ + DOM.getPanel = function(pActive){ var lPanel = DOM.getCurrentFile().parentElement; /* if {active : false} getting passive panel */ @@ -675,11 +743,14 @@ var CloudCommander, $, Util, DOM, CloudFunc; return lPanel; }; - DOM.show = function(pElement){ + DOM.show = function(pElement){ DOM.removeClass(pElement, 'hidden'); }; - DOM.showPanel = function(pActive){ + /** + * shows panel right or left (or active) + */ + DOM.showPanel = function(pActive){ var lRet = true, lPanel = DOM.getPanel(pActive); @@ -691,7 +762,10 @@ var CloudCommander, $, Util, DOM, CloudFunc; return lRet; }; - DOM.hidePanel = function(pActive){ + /** + * hides panel right or left (or active) + */ + DOM.hidePanel = function(pActive){ var lRet = false, lPanel = DOM.getPanel(pActive); @@ -701,19 +775,29 @@ var CloudCommander, $, Util, DOM, CloudFunc; return lRet; }; + /** + * add class=hidden to element + * + * @param pElement + */ DOM.hide = function(pElement){ return DOM.addClass(pElement, 'hidden'); }; /** * remove child of element - * @pChild - * @pElement + * @param pChild + * @param pElement */ DOM.remove = function(pChild, pElement){ return (pElement || document.body).removeChild(pChild); }; + /** + * remove class pClass from element pElement + * @param pElement + * @param pClass + */ DOM.removeClass = function(pElement, pClass){ var lRet_b = true, lClassList = pElement.classList; @@ -727,7 +811,11 @@ var CloudCommander, $, Util, DOM, CloudFunc; return lRet_b; }; - DOM.removeCurrent = function(pCurrent){ + /** + * remove current file from file table + * @pCurrent + */ + DOM.removeCurrent = function(pCurrent){ var lParent = pCurrent.parentElement; if(!pCurrent) @@ -760,7 +848,12 @@ var CloudCommander, $, Util, DOM, CloudFunc; return pCurrent; }; - DOM.scrollIntoViewIfNeeded = function(pElement){ + /** + * unified way to scrollIntoViewIfNeeded + * (native suporte by webkit only) + * @param pElement + */ + DOM.scrollIntoViewIfNeeded = function(pElement){ var lRet = true; if(pElement && pElement.scrollIntoViewIfNeeded) @@ -771,11 +864,10 @@ var CloudCommander, $, Util, DOM, CloudFunc; return lRet; }; - /** * function gets time */ - DOM.getTime = function(){ + DOM.getTime = function(){ var date = new Date(), hours = date.getHours(), minutes = date.getMinutes(), @@ -787,9 +879,16 @@ var CloudCommander, $, Util, DOM, CloudFunc; return hours + ":" + minutes + ":" + seconds; }; - DOM.CloudStatus = []; + /** + * array of all statuses of opertattions + */ + DOM.CloudStatus = []; - DOM.addCloudStatus = function(pStatus){ + /** + * adds status of operation + * @param pStatus + */ + DOM.addCloudStatus = function(pStatus){ DOM.CloudStatus[DOM.CloudStatus.length] = pStatus; }; })(); \ No newline at end of file diff --git a/lib/server/rest.js b/lib/server/rest.js index 3dcecaeb..8137a191 100644 --- a/lib/server/rest.js +++ b/lib/server/rest.js @@ -7,7 +7,7 @@ main = require(DIR + 'lib/server/main'), Util = main.util, - APIURL = '/api/v1/'; + APIURL = '/api/v1'; /** * rest interface @@ -24,8 +24,8 @@ console.log(lMethod); if( Util.isContainStr(lUrl, APIURL) ){ - console.log('api !!!!!!!!!!!! '); - return true; + lRes.end(APIURL); + lRet = true; } return lRet; diff --git a/lib/util.js b/lib/util.js index e713b5ab..14a1a412 100644 --- a/lib/util.js +++ b/lib/util.js @@ -225,7 +225,9 @@ var Util, exports; return Util.log(lRet); }; /** - * function do save exec + * function do save exec of function + * @param pCallBack + * @param pArg */ Util.exec = function(pCallBack, pArg){ var lRet = false; @@ -237,7 +239,7 @@ var Util, exports; }; /** - * function gets time + * Gets current time in format hh:mm:ss */ Util.getTime = function(){ var date = new Date(), diff --git a/server.js b/server.js index e61d143c..02a3c1e5 100644 --- a/server.js +++ b/server.js @@ -806,7 +806,7 @@ CloudServer.sendResponse = function(pHead, pData, pName){ lStatus = CloudServer.Statuses[pName]; if(lResponse){ - lResponse.writeHead(lStatus, pHead); + lResponse.writeHead(lStatus, pHead); lResponse.end(pData); console.log(pName + ' sended'); @@ -821,4 +821,4 @@ CloudServer.sendResponse = function(pHead, pData, pName){ exports.start = function(pConfig, pProcessing){ CloudServer.start(pConfig, pProcessing); }; -exports.CloudServer = CloudServer; \ No newline at end of file +exports.CloudServer = CloudServer; \ No newline at end of file