closure-todo.txt

   1 Many of the functions and methods in the dygraphs source have some form of
   2 Closure annotations on them ("@param", "@return", "@private", etc.).
   3
   4 These provide some documentation value, but they were largely written by
   5 developers who had never used the Closure Compiler and so the syntax is
   6 often not quite correct.
   7
   8 This file tracks which files have been fully "closurized", i.e. compile
   9 under the Closure Compiler without any errors or warnings.
  10
  11 Core:
  12 - dygraph-canvas.js
  13 - dygraph-interaction-model.js
  14 - dygraph-layout.js
  15 x dygraph-options.js
  16 - dygraph.js
  17 x dygraph-gviz.js
  18 x dygraph-tickers.js
  19 x dygraph-options-reference.js
  20 x dygraph-utils.js
  21 x dashed-canvas.js
  22 - dygraph-plugin-base.js
  23 - dygraph-plugin-install.js
  24
  25 Plugins:
  26 - plugins/annotations.js
  27 - plugins/axes.js
  28 - plugins/chart-labels.js
  29 - plugins/grid.js
  30 - plugins/legend.js
  31 - plugins/range-selector.js
  32
  33 Datahandler:
  34 - datahandler/bars-custom.js
  35 - datahandler/bars-error.js
  36 - datahandler/bars-fractions.js
  37 - datahandler/bars.js
  38 - datahandler/datahandler.js
  39 - datahandler/default-fractions.js
  40 - datahandler/default.js
  41
  42 Here's a command that can be used to build dygraphs using the closure
  43 compiler:
  44 java -jar ../../closure-compiler-read-only/build/compiler.jar --js=dygraph-utils.js --js=dashed-canvas.js --js=dygraph-options-reference.js --js=dygraph-tickers.js --js=dygraph-gviz.js --js=dygraph-options.js --js_output_file=/tmp/out.js --compilation_level ADVANCED_OPTIMIZATIONS --warning_level VERBOSE --externs dygraph-externs.js
  45
  46 As each file is closurized, it can be added as a "--js" parameter.