docs(generators): @fileoverview -> @file

With an update to the wording for generators/php.ts.
google · Nov 18, 2023 · 8686f5d · 8686f5d
1 parent 5c3afa3
commit 8686f5d
Show file tree

Hide file tree

Showing 10 changed files with 12 additions and 12 deletions.
diff --git a/generators/php.ts b/generators/php.ts
@@ -5,9 +5,9 @@
  */
 
 /**
- * @fileoverview Complete helper functions for generating PHP for
- *     blocks.  This is the entrypoint for php_compressed.js.
- * @suppress {extraRequire}
+ * @file Instantiate a PhpGenerator and populate it with the complete
+ * set of block generator functions for PHP.  This is the entrypoint
+ * for php_compressed.js.
  */
 
 // Former goog.module ID: Blockly.PHP.all

diff --git a/generators/php/colour.ts b/generators/php/colour.ts
@@ -5,7 +5,7 @@
  */
 
 /**
- * @fileoverview Generating PHP for colour blocks.
+ * @file Generating PHP for colour blocks.
  */
 
 // Former goog.module ID: Blockly.PHP.colour

diff --git a/generators/php/lists.ts b/generators/php/lists.ts
@@ -5,7 +5,7 @@
  */
 
 /**
- * @fileoverview Generating PHP for list blocks.
+ * @file Generating PHP for list blocks.
  */
 
 /**

diff --git a/generators/php/logic.ts b/generators/php/logic.ts
@@ -5,7 +5,7 @@
  */
 
 /**
- * @fileoverview Generating PHP for logic blocks.
+ * @file Generating PHP for logic blocks.
  */
 
 // Former goog.module ID: Blockly.PHP.logic

diff --git a/generators/php/loops.ts b/generators/php/loops.ts
@@ -5,7 +5,7 @@
  */
 
 /**
- * @fileoverview Generating PHP for loop blocks.
+ * @file Generating PHP for loop blocks.
  */
 
 // Former goog.module ID: Blockly.PHP.loops

diff --git a/generators/php/math.ts b/generators/php/math.ts
@@ -5,7 +5,7 @@
  */
 
 /**
- * @fileoverview Generating PHP for math blocks.
+ * @file Generating PHP for math blocks.
  */
 
 // Former goog.module ID: Blockly.PHP.math

diff --git a/generators/php/procedures.ts b/generators/php/procedures.ts
@@ -5,7 +5,7 @@
  */
 
 /**
- * @fileoverview Generating PHP for procedure blocks.
+ * @file Generating PHP for procedure blocks.
  */
 
 // Former goog.module ID: Blockly.PHP.procedures

diff --git a/generators/php/text.ts b/generators/php/text.ts
@@ -5,7 +5,7 @@
  */
 
 /**
- * @fileoverview Generating PHP for text blocks.
+ * @file Generating PHP for text blocks.
  */
 
 // Former goog.module ID: Blockly.PHP.texts

diff --git a/generators/php/variables.ts b/generators/php/variables.ts
@@ -5,7 +5,7 @@
  */
 
 /**
- * @fileoverview Generating PHP for variable blocks.
+ * @file Generating PHP for variable blocks.
  */
 
 // Former goog.module ID: Blockly.PHP.variables

diff --git a/generators/php/variables_dynamic.ts b/generators/php/variables_dynamic.ts
@@ -5,7 +5,7 @@
  */
 
 /**
- * @fileoverview Generating PHP for dynamic variable blocks.
+ * @file Generating PHP for dynamic variable blocks.
  */
 
 // Former goog.module ID: Blockly.PHP.variablesDynamic
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,7 +5,7 @@ @@
      */
     /**
-     * @fileoverview Generating PHP for colour blocks.
+     * @file Generating PHP for colour blocks.
      */
     // Former goog.module ID: Blockly.PHP.colour
@@ Expand Down @@