From: Dan Vanderkam Date: Mon, 14 Oct 2013 03:23:27 +0000 (-0400) Subject: jsdoc X-Git-Tag: v1.1.0~81^2 X-Git-Url: https://adrianiainlam.tk/git/?a=commitdiff_plain;h=1c420f2f9cf0477347061f7713e111d74e47af47;p=dygraphs.git jsdoc --- diff --git a/dygraph.js b/dygraph.js index 1600cb2..19360c9 100644 --- a/dygraph.js +++ b/dygraph.js @@ -669,6 +669,7 @@ Dygraph.prototype.getOption = function(name, opt_seriesName) { }; /** + * Like getOption(), but specifically returns a number. * This is a convenience function for working with the Closure Compiler. * @param {string} name The name of the option (e.g. 'strokeWidth') * @param {string=} opt_seriesName Series name to get per-series values. @@ -680,6 +681,7 @@ Dygraph.prototype.getNumericOption = function(name, opt_seriesName) { }; /** + * Like getOption(), but specifically returns a string. * This is a convenience function for working with the Closure Compiler. * @param {string} name The name of the option (e.g. 'strokeWidth') * @param {string=} opt_seriesName Series name to get per-series values. @@ -691,6 +693,7 @@ Dygraph.prototype.getStringOption = function(name, opt_seriesName) { }; /** + * Like getOption(), but specifically returns a boolean. * This is a convenience function for working with the Closure Compiler. * @param {string} name The name of the option (e.g. 'strokeWidth') * @param {string=} opt_seriesName Series name to get per-series values. @@ -702,6 +705,7 @@ Dygraph.prototype.getBooleanOption = function(name, opt_seriesName) { }; /** + * Like getOption(), but specifically returns a function. * This is a convenience function for working with the Closure Compiler. * @param {string} name The name of the option (e.g. 'strokeWidth') * @param {string=} opt_seriesName Series name to get per-series values.