A few lines explaining what the exports.js plugin does

2013-04-10 11:04:39 +02:00
parent 6f94ec6fe7
commit 423ba5c0e4
1 changed files with 6 additions and 0 deletions
--- a/doc/plugins/exports.js
+++ b/doc/plugins/exports.js
@@ -1,3 +1,9 @@
+/*
+ * This plugin parses goog.exportSymbol and goog.exportProperty calls to build
+ * a list of API symbols and properties. Everything else is marked undocumented,
+ * which will remove it from the docs.
+ */
+
 var api = [];

 function collectExports(source) {