docs: add file header

eslint · May 4, 2022 · cec9310 · cec9310
1 parent a58a1f3
commit cec9310
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/tools/js-for-ts.js b/tools/js-for-ts.js
@@ -1,3 +1,14 @@
+/**
+ * @fileoverview Tool to prepare JavaScript (+JSDoc) for TypeScript, inlining
+ * `@local`-marked `@typedef`'s, and building a faux class for `@export`-marked
+ * classes so the type can be exported out of a given file.
+ * @author Brett Zamir
+ */
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
 import js2tsAssistant from "@es-joy/js2ts-assistant";
 
 await js2tsAssistant({