From: David M Sibley <dmsibley@usgs.gov>
Date: Wed, 17 Apr 2013 23:10:44 +0000 (-0500)
Subject: adding comments for LONG_TICK_PLACEMENTS
X-Git-Tag: v1.0.0~36^2
X-Git-Url: https://adrianiainlam.tk/git/?a=commitdiff_plain;h=2f5f8198b319a142c0f8578d98c57a940e24fbe2;p=dygraphs.git

adding comments for LONG_TICK_PLACEMENTS
---

diff --git a/dygraph-tickers.js b/dygraph-tickers.js
index 715ef7e..f4778b1 100644
--- a/dygraph-tickers.js
+++ b/dygraph-tickers.js
@@ -259,7 +259,13 @@ Dygraph.SHORT_SPACINGS[Dygraph.SIX_HOURLY]      = 1000 * 3600 * 6;
 Dygraph.SHORT_SPACINGS[Dygraph.DAILY]           = 1000 * 86400;
 Dygraph.SHORT_SPACINGS[Dygraph.WEEKLY]          = 1000 * 604800;
 
-/** @type {Array.<Object>} */
+/** 
+ * A collection of objects specifying where it is acceptable to place tick
+ * marks for granularities larger than WEEKLY.  
+ * 'months' is an array of month indexes on which to place tick marks.
+ * 'year_mod' ticks are placed when year % year_mod = 0.
+ * @type {Array.<Object>} 
+ */
 Dygraph.LONG_TICK_PLACEMENTS = [];
 Dygraph.LONG_TICK_PLACEMENTS[Dygraph.MONTHLY] = {
   months : [0,1,2,3,4,5,6,7,8,9,10,11],