Skip to content

Commit

Permalink
updated jsdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
vpodk committed Jun 17, 2015
1 parent c2b5662 commit 5b4cfb4
Show file tree
Hide file tree
Showing 10 changed files with 109 additions and 72 deletions.
26 changes: 23 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,15 @@ <h2>



<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="http://google.github.io/styleguide/javascriptguide.xml">http://google.github.io/styleguide/javascriptguide.xml</a></li>

<li>developers.google.com/closure/compiler/docs/js-for-compiler</li>
</ul>
</dd>



</dl>
Expand Down Expand Up @@ -491,9 +500,11 @@ <h2>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="http://www.w3.org/TR/webstorage/">http://www.w3.org/TR/webstorage/</a></li>

<li><a href="http://google.github.io/styleguide/javascriptguide.xml">http://google.github.io/styleguide/javascriptguide.xml</a></li>

<li>developers.google.com/closure/compiler/docs/js-for-compiler</li>
<li><a href="http://developers.google.com/closure/compiler/docs/js-for-compiler">http://developers.google.com/closure/compiler/docs/js-for-compiler</a></li>
</ul>
</dd>

Expand Down Expand Up @@ -700,7 +711,7 @@ <h2>
<ul>
<li><a href="http://google.github.io/styleguide/javascriptguide.xml">http://google.github.io/styleguide/javascriptguide.xml</a></li>

<li>developers.google.com/closure/compiler/docs/js-for-compiler</li>
<li><a href="http://developers.google.com/closure/compiler/docs/js-for-compiler">http://developers.google.com/closure/compiler/docs/js-for-compiler</a></li>
</ul>
</dd>

Expand Down Expand Up @@ -1955,6 +1966,15 @@ <h2>



<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="http://google.github.io/styleguide/javascriptguide.xml">http://google.github.io/styleguide/javascriptguide.xml</a></li>

<li>developers.google.com/closure/compiler/docs/js-for-compiler</li>
</ul>
</dd>



</dl>
Expand Down Expand Up @@ -2582,7 +2602,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="controls.
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Wed Jun 17 2015 00:59:31 GMT+0300 (EEST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Wed Jun 17 2015 09:56:44 GMT+0300 (EEST)
</footer>

<script> prettyPrint(); </script>
Expand Down
28 changes: 18 additions & 10 deletions src/controls/Calendar.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@

/**
* @fileoverview Calendar control.
* @link http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml
* @link https://developers.google.com/closure/compiler/docs/js-for-compiler
*
* @see http://google.github.io/styleguide/javascriptguide.xml
* @see developers.google.com/closure/compiler/docs/js-for-compiler
*/



/**
* Constructor of Calendar.
* Constructor of Calendar control.
* @param {string|Node} container The HTML container or its ID.
* @param {Object=} opt_options Optional options.
* @extends {dom.EventDispatcher} dom.EventDispatcher
Expand Down Expand Up @@ -137,8 +138,8 @@ controls.Calendar = function(container, opt_options) {
*/
this.clear = function() {
selected_ = [];
var cellDate;
var now = formatter_.format(new Date(), 'YYYY-MM-dd');
/** @type {string} */ var now = formatter_.format(new Date(), 'YYYY-MM-dd');
/** @type {string} */ var cellDate;

self_.each(function(cell) {
cellDate = cell.getAttribute('value');
Expand All @@ -164,8 +165,9 @@ controls.Calendar = function(container, opt_options) {
/** @type {HTMLTableRowElement} */ var row = rows[rows.length - 1];
/** @type {number} */ var content = 0;
/** @type {number} */ var i = 0;
/** @type {number} */ var length = row.cells.length;

for (; i < row.cells.length;) {
for (; i < length;) {
content += +row.cells[i++].innerHTML || 0;
}

Expand Down Expand Up @@ -204,8 +206,9 @@ controls.Calendar = function(container, opt_options) {
headers[headers.length - 1]
];
/** @type {number} */ var i = 0;
/** @type {number} */ var length = cells.length;

for (; i < cells.length; i++) {
for (; i < length; i++) {
dom.events.addEventListener(cells[i], dom.events.TYPE.CLICK, function(e) {
self_.dispatchEvent((dom.events.getEventTarget(e)).cellIndex ?
self_.events.NEXT_MONTH : self_.events.PREV_MONTH);
Expand All @@ -225,19 +228,24 @@ controls.Calendar = function(container, opt_options) {
*/
function clickHandler_(e) {
/** @type {EventTarget} */ var target = dom.events.getEventTarget(e);


if (!isNaN(+target.innerHTML)) {
/** @type {Date} */ var selected = formatter_.parse(
target.getAttribute('value'), opt_options['format']);
/** @type {number} */ var index;
/** @type {Date} */ var start;
/** @type {Date} */ var end;

if (opt_options['multiple'] && !first_) {
selected_.push(selected);
/** @type {number} */ var index = selected_.length - 1;
index = selected_.length - 1;
if (selected_[0] > selected_[index]) {
selected_.reverse();
}

/** @type {Date} */ var start = selected_[0];
/** @type {Date} */ var end = new Date(selected_[index]);
start = selected_[0];
end = new Date(selected_[index]);
while (end > start) {
end.setDate(end.getDate() - 1);
selected_.splice(1, 0, new Date(end.getTime()));
Expand Down
51 changes: 28 additions & 23 deletions src/dom/DataStorage.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
/**
* @fileoverview Provides data persistence using HTML5 local storage mechanism.
*
* @see: {@link http://www.w3.org/TR/webstorage/#the-localstorage-attribute}
* @see {@link http://google.github.io/styleguide/javascriptguide.xml}
* @see {@link developers.google.com/closure/compiler/docs/js-for-compiler}
* @see http://www.w3.org/TR/webstorage/
* @see http://google.github.io/styleguide/javascriptguide.xml
* @see http://developers.google.com/closure/compiler/docs/js-for-compiler
*/


Expand All @@ -19,11 +19,11 @@
* @param {Object.<string, *>=} opt_options Optional configuration options.
* @example
* options: {
* 'type': 'local' // Storage types: local, session, cookie.
* 'type': 'local' // Storage types: local, session, cookie.
* 'compress': false, // Enables LZW compression.
* 'session': {
* 'key': 'ds-sid', // Session cookie key.
* 'ttl': 30 // Time to live.
* 'ttl': 30 // Time to live.
* }
* }
*/
Expand All @@ -36,7 +36,7 @@ dom.DataStorage = function(opt_options) {
*/
this.set = function(key, value) {
/** @type {string} */ var result = stringify_(value);
if ('cookie' == options_['type']) {
if ('cookie' === options_['type']) {
dom.Cookies.set(key, result, 365);
} else if (nativeStorage_) {
nativeStorage_.setItem(key, result);
Expand All @@ -49,7 +49,7 @@ dom.DataStorage = function(opt_options) {
data_[key] = result;
}

if ('session' == options_['type'] && !nativeStorage_) {
if ('session' === options_['type'] && !nativeStorage_) {
dom.Cookies.set(options_['session']['key'], +new Date + '', 1);
}
};
Expand All @@ -61,7 +61,7 @@ dom.DataStorage = function(opt_options) {
*/
this.get = function(key) {
/** @type {?string} */ var value = data_[key];
if ('cookie' == options_['type']) {
if ('cookie' === options_['type']) {
value = dom.Cookies.get(key);
} else if (nativeStorage_) {
value = nativeStorage_.getItem(key);
Expand All @@ -78,7 +78,7 @@ dom.DataStorage = function(opt_options) {
* @param {string} key The key to remove.
*/
this.remove = function(key) {
if ('cookie' == options_['type']) {
if ('cookie' === options_['type']) {
dom.Cookies.remove(key);
} else if (nativeStorage_) {
nativeStorage_.removeItem(key);
Expand All @@ -99,7 +99,7 @@ dom.DataStorage = function(opt_options) {
/** @type {number} */ var i = 0;
/** @type {string} */ var key;

if ('cookie' == options_['type']) {
if ('cookie' === options_['type']) {
dom.Cookies.clear();
} else if (nativeStorage_) {
nativeStorage_.clear();
Expand Down Expand Up @@ -157,20 +157,24 @@ dom.DataStorage = function(opt_options) {
nativeStorage_ = key in window && window[key];
} catch (e) {}

key = 'globalStorage';
/** @preserveTry */
try {
globalStorage_ = key in window && window[key] &&
window[key][location.hostname];
} catch (e) {}
if (!nativeStorage_) {
key = 'globalStorage';
/** @preserveTry */
try {
globalStorage_ = key in window && window[key] &&
window[key][location.hostname];
} catch (e) {}
}

/** @preserveTry */
try {
userData_ = dom.createElement('userdata');
userData_['addBehavior']('#default#userData');
dom.document.body.appendChild(userData_);
userData_['load'](userData_.tagName);
} catch (e) {}
if (!globalStorage_) {
/** @preserveTry */
try {
userData_ = dom.createElement('userdata');
userData_['addBehavior']('#default#userData');
dom.document.body.appendChild(userData_);
userData_['load'](userData_.tagName);
} catch (e) {}
}

checkSession_();
}
Expand All @@ -183,6 +187,7 @@ dom.DataStorage = function(opt_options) {
if ('session' === options_['type'] && !nativeStorage_) {
/** @type {!Object} */ var session = options_['session'];
/** @type {string} */ var timestamp = dom.Cookies.get(session['key']);

if (timestamp && +timestamp + session['ttl'] * 6e4 < +new Date) {
self_.clear();
}
Expand Down
4 changes: 2 additions & 2 deletions src/dom/Template.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
/**
* @fileoverview Simple logic-less template engine.
*
* @see {@link http://google.github.io/styleguide/javascriptguide.xml}
* @see {@link developers.google.com/closure/compiler/docs/js-for-compiler}
* @see http://google.github.io/styleguide/javascriptguide.xml
* @see http://developers.google.com/closure/compiler/docs/js-for-compiler
*/


Expand Down
1 change: 1 addition & 0 deletions src/formatters/DateFormatter.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@

/**
* @fileoverview Date format library.
*
* @link https://google.github.io/styleguide/javascriptguide.xml
* @link https://developers.google.com/closure/compiler/docs/js-for-compiler
*/
Expand Down
1 change: 1 addition & 0 deletions src/formatters/NumberFormatter.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@

/**
* @fileoverview Number format library.
*
* @link https://google.github.io/styleguide/javascriptguide.xml
* @link https://developers.google.com/closure/compiler/docs/js-for-compiler
*/
Expand Down
5 changes: 3 additions & 2 deletions src/formatters/__ns__.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@

/**
* @fileoverview Defines 'formatters' namespace.
* @link https://google.github.io/styleguide/javascriptguide.xml
* @link https://developers.google.com/closure/compiler/docs/js-for-compiler
*
* @see http://google.github.io/styleguide/javascriptguide.xml
* @see http://developers.google.com/closure/compiler/docs/js-for-compiler
*/


Expand Down
8 changes: 4 additions & 4 deletions src/util/Base64.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
/**
* @fileoverview Base64 utility methods.
*
* @see {@link https://en.wikipedia.org/wiki/Base64}
* @see {@link http://google.github.io/styleguide/javascriptguide.xml}
* @see {@link developers.google.com/closure/compiler/docs/js-for-compiler}
* @see https://en.wikipedia.org/wiki/Base64
* @see http://google.github.io/styleguide/javascriptguide.xml
* @see developers.google.com/closure/compiler/docs/js-for-compiler
*/


/**
* Base64 utility methods.
* @namespace
* @see {@link https://en.wikipedia.org/wiki/Base64}
* @see https://en.wikipedia.org/wiki/Base64
*/
util.Base64 = {
/**
Expand Down
52 changes: 26 additions & 26 deletions src/util/FileUtils.js
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@

/**
* @fileoverview Miscellaneous files utility methods.
* @link http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml
* @link https://developers.google.com/closure/compiler/docs/js-for-compiler
*
* @see http://google.github.io/styleguide/javascriptguide.xml
* @see developers.google.com/closure/compiler/docs/js-for-compiler
*/


/**
* Miscellaneous files utility methods.
* @requires util.Base64
* @namespace
*/
util.FileUtils = {};


/**
* @param {string} data Data content.
* @param {string=} opt_fileName Optional file name.
* @param {string=} opt_contentType Optional content type.
* @static
*/
util.FileUtils.saveAs = function(data, opt_fileName, opt_contentType) {
/** @type {Element} */ var link = dom.createElement('A');
opt_fileName = opt_fileName || 'file';
opt_contentType = opt_contentType || 'text/plain';
if (window.Blob && 'download' in link) {
link['href'] = (window.URL || window.webkitURL).createObjectURL(
new Blob([data],
{'type': opt_contentType + ';charset=' + dom.CHARSET}));
link.setAttribute('download', opt_fileName);
dom.document.body.appendChild(link);
link.click();
} else {
// @link http://msdn.microsoft.com/en-us/library/cc848897(VS.85).aspx
window.open('data:' + opt_contentType +
';base64,' + util.StringUtils.Base64.encode(data));
util.FileUtils = {
/**
* @param {string} data Data content.
* @param {string=} opt_fileName Optional file name.
* @param {string=} opt_contentType Optional content type.
* @see http://msdn.microsoft.com/en-us/library/cc848897(VS.85).aspx
*/
saveAs: function(data, opt_fileName, opt_contentType) {
/** @type {Element} */ var link = dom.createElement('A');
opt_fileName = opt_fileName || 'file';
opt_contentType = opt_contentType || 'text/plain';
if (window['Blob'] && 'download' in link) {
link['href'] = (window['URL'] || window['webkitURL']).createObjectURL(
new window['Blob']([data],
{'type': opt_contentType + ';charset=' + dom.CHARSET}));
link.setAttribute('download', opt_fileName);
dom.document.body.appendChild(link);
link.click();
} else {
window.open('data:' + opt_contentType +
';base64,' + util.Base64.encode(data));
}
}
};
5 changes: 3 additions & 2 deletions src/util/__ns__.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@

/**
* @fileoverview Defines namespace for 'util' package.
* @link http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml
* @link https://developers.google.com/closure/compiler/docs/js-for-compiler
*
* @see http://google.github.io/styleguide/javascriptguide.xml
* @see developers.google.com/closure/compiler/docs/js-for-compiler
*/


Expand Down

0 comments on commit 5b4cfb4

Please sign in to comment.