From f9157a61231a230df07ed09792cecaa39f57164f Mon Sep 17 00:00:00 2001
From: Tim Schaub <tim.schaub@gmail.com>
Date: Sun, 4 May 2014 15:01:17 -0700
Subject: [PATCH] Rename generate-symbols.js to generate-info.js

This task generates build related metadata for the library based on doc annotations.  Since it is about more than writing out exportable symbols, it makes sense to have a more general name.
---
 buildcfg/jsdoc/{symbols => info}/conf.json        |  6 +++---
 buildcfg/jsdoc/{symbols => info}/define-plugin.js |  0
 buildcfg/jsdoc/{symbols => info}/publish.js       |  0
 buildcfg/jsdoc/{symbols => info}/todo-plugin.js   |  0
 tasks/generate-exports.js                         | 10 +++++-----
 tasks/{generate-symbols.js => generate-info.js}   |  4 ++--
 tasks/readme.md                                   |  4 ++--
 7 files changed, 12 insertions(+), 12 deletions(-)
 rename buildcfg/jsdoc/{symbols => info}/conf.json (57%)
 rename buildcfg/jsdoc/{symbols => info}/define-plugin.js (100%)
 rename buildcfg/jsdoc/{symbols => info}/publish.js (100%)
 rename buildcfg/jsdoc/{symbols => info}/todo-plugin.js (100%)
 rename tasks/{generate-symbols.js => generate-info.js} (98%)

diff --git a/buildcfg/jsdoc/symbols/conf.json b/buildcfg/jsdoc/info/conf.json
similarity index 57%
rename from buildcfg/jsdoc/symbols/conf.json
rename to buildcfg/jsdoc/info/conf.json
index fc647e450c..90eab39059 100644
--- a/buildcfg/jsdoc/symbols/conf.json
+++ b/buildcfg/jsdoc/info/conf.json
@@ -1,7 +1,7 @@
 {
     "opts": {
         "recurse": true,
-        "template": "buildcfg/jsdoc/symbols"
+        "template": "buildcfg/jsdoc/info"
     },
     "tags": {
         "allowUnknownTags": true
@@ -10,7 +10,7 @@
         "includePattern": "\\.js$"
     },
     "plugins": [
-        "buildcfg/jsdoc/symbols/define-plugin",
-        "buildcfg/jsdoc/symbols/todo-plugin"
+        "buildcfg/jsdoc/info/define-plugin",
+        "buildcfg/jsdoc/info/todo-plugin"
     ]
 }
diff --git a/buildcfg/jsdoc/symbols/define-plugin.js b/buildcfg/jsdoc/info/define-plugin.js
similarity index 100%
rename from buildcfg/jsdoc/symbols/define-plugin.js
rename to buildcfg/jsdoc/info/define-plugin.js
diff --git a/buildcfg/jsdoc/symbols/publish.js b/buildcfg/jsdoc/info/publish.js
similarity index 100%
rename from buildcfg/jsdoc/symbols/publish.js
rename to buildcfg/jsdoc/info/publish.js
diff --git a/buildcfg/jsdoc/symbols/todo-plugin.js b/buildcfg/jsdoc/info/todo-plugin.js
similarity index 100%
rename from buildcfg/jsdoc/symbols/todo-plugin.js
rename to buildcfg/jsdoc/info/todo-plugin.js
diff --git a/tasks/generate-exports.js b/tasks/generate-exports.js
index ab5c4d4b21..70d5dd2b40 100644
--- a/tasks/generate-exports.js
+++ b/tasks/generate-exports.js
@@ -5,7 +5,7 @@ var async = require('async');
 var fse = require('fs-extra');
 var nomnom = require('nomnom');
 
-var generateSymbols = require('./generate-symbols');
+var generateInfo = require('./generate-info');
 
 var build = path.join(__dirname, '..', 'build');
 
@@ -49,18 +49,18 @@ function getPatterns(configPath, callback) {
 
 
 /**
- * Read the symbols file.
+ * Read the symbols from info file.
  * @param {Array.<string>} patterns List of patterns to pass along.
  * @param {funciton(Error, Array.<string>, Array.<Object>)} callback Called
  *     with the patterns and symbols (or any error).
  */
 function getSymbols(patterns, callback) {
-  generateSymbols(function(err) {
+  generateInfo(function(err) {
     if (err) {
-      callback(new Error('Trouble generating symbols: ' + err.message));
+      callback(new Error('Trouble generating info: ' + err.message));
       return;
     }
-    var symbols = require('../build/symbols.json').symbols;
+    var symbols = require('../build/info.json').symbols;
     callback(null, patterns, symbols);
   });
 }
diff --git a/tasks/generate-symbols.js b/tasks/generate-info.js
similarity index 98%
rename from tasks/generate-symbols.js
rename to tasks/generate-info.js
index 97c0ad5b10..b89002aa3e 100644
--- a/tasks/generate-symbols.js
+++ b/tasks/generate-info.js
@@ -7,10 +7,10 @@ var fse = require('fs-extra');
 var walk = require('walk').walk;
 
 var sourceDir = path.join(__dirname, '..', 'src', 'ol');
-var infoPath = path.join(__dirname, '..', 'build', 'symbols.json');
+var infoPath = path.join(__dirname, '..', 'build', 'info.json');
 var jsdoc = path.join(__dirname, '..', 'node_modules', '.bin', 'jsdoc');
 var jsdocConfig = path.join(
-    __dirname, '..', 'buildcfg', 'jsdoc', 'symbols', 'conf.json');
+    __dirname, '..', 'buildcfg', 'jsdoc', 'info', 'conf.json');
 
 
 /**
diff --git a/tasks/readme.md b/tasks/readme.md
index 5710e143c9..ca57c7b137 100644
--- a/tasks/readme.md
+++ b/tasks/readme.md
@@ -66,9 +66,9 @@ To generate a build named `ol.min.js` with the `build.json`, you would run this:
 Called internally to generate a `build/exports.js` file optionally with a limited set of exports.
 
 
-## `generate-symbols.js`
+## `generate-info.js`
 
-Called internally to parse the library for API annotations and write out a `build/symbols.json` file.
+Called internally to parse the library for annotations and write out a `build/info.json` file.
 
 
 ## `parse-examples.js`