Add jsdoc for setAnnotations() and an example of how to use them with native-format...

[dygraphs.git] / dygraph.js

diff --git a/dygraph.js b/dygraph.js
index ff05507..f90f461 100644 (file)
--- a/dygraph.js
+++ b/dygraph.js
@@ -2969,6 +2969,9 @@ Dygraph.prototype.size = function() {
 
 /**
  * Update the list of annotations and redraw the chart.
+ * See dygraphs.com/annotations.html for more info on how to use annotations.
+ * @param ann {Array} An array of annotation objects.
+ * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
  */
 Dygraph.prototype.setAnnotations = function(ann, suppressDraw) {
   // Only add the annotation CSS rule once we know it will be used.