fix(storage-control): Update jsdocs headers in v2 clients to include … (#7851)

* fix(storage-control): Update jsdocs headers in v2 clients to include internal to avoid generating docs

* don't strip internal from the .d.ts

Author: ddelgrosso1

…age-control/src/util/sample_fix_utils.ts …ol/src/util/samples_and_doc_fix_utils.tspackages/google-storage-control/src/util/sample_fix_utils.ts renamed to packages/google-storage-control/src/util/samples_and_doc_fix_utils.ts packages/google-storage-control/src/util/sample_fix_utils.ts renamed to packages/google-storage-control/src/util/samples_and_doc_fix_utils.ts

@@ -15,6 +15,9 @@
 import * as fs from 'fs';
 import * as path from 'path';
 
+/**
+ * Updates generated samples by replacing storage with storage-control imports and initializations.
+ */
 export function updateSamples() {
   const dirPath = path.join(
     __dirname,
@@ -71,3 +74,36 @@ export function updateSamples() {
     }
   }
 }
+
+/**
+ * Appends the @internal tag to the class level documentation headers of generated clients.
+ * This ensures that the docs pipeline ignores these classes when generating documentation.
+ */
+export function fixDocsHeaders() {
+  const dirPath = path.join(__dirname, '..', 'v2');
+  const files = ['storage_client.ts', 'storage_control_client.ts'];
+
+  for (const file of files) {
+    const filePath = path.join(dirPath, file);
+    if (!fs.existsSync(filePath)) {
+      continue;
+    }
+
+    let content = fs.readFileSync(filePath, 'utf8');
+    
+    // Check if @internal is already present in the block to prevent duplicate additions
+    const replaceRegex = /\* @memberof v2\n \*\/(?!\s*export class)/g;
+    
+    // We want to target the class documentation block that ends with `* @memberof v2\n */\nexport class `
+    // and replace it with `* @memberof v2\n * @internal\n */\nexport class `
+    const classDocRegex = /(\* @memberof v2\n) \*\/\nexport class /g;
+    
+    if (classDocRegex.test(content)) {
+      content = content.replace(classDocRegex, '$1 * @internal\n */\nexport class ');
+      fs.writeFileSync(filePath, content);
+      console.log(`Successfully added @internal to doc header in: ${filePath}`);
+    } else {
+      console.log(`Did not find the expected doc header format in: ${filePath}`);
+    }
+  }
+}

packages/google-storage-control/src/util/storage_control_utils.ts

@@ -20,13 +20,14 @@ import {
 } from './proto_utils';
 import {buildOutput} from './uber_client_builder';
 import {fixIndexFile, fixV2Index} from './index_fix_utils';
-import {updateSamples} from './sample_fix_utils';
+import {updateSamples, fixDocsHeaders} from './samples_and_doc_fix_utils';
 
 async function main() {
   fixIndexFile('src/index.ts');
   fixV2Index('v2/index.ts');
   cleanObjectReferences(filesToUpdate, replacements);
   updateSamples();
+  fixDocsHeaders();
   const finaloutput = await buildOutput();
   fs.writeFile('../storage_control_client.ts', finaloutput, err => {
     if (err) throw err;

packages/google-storage-control/src/v2/storage_client.ts

@@ -68,6 +68,7 @@ const version = require('../../../package.json').version;
  *  any other character (no special directory semantics).
  * @class
  * @memberof v2
+ * @internal
  */
 export class StorageClient {
   private _terminated = false;

packages/google-storage-control/src/v2/storage_control_client.ts

@@ -45,6 +45,7 @@ const version = require('../../../package.json').version;
  *  StorageControl service includes selected control plane operations.
  * @class
  * @memberof v2
+ * @internal
  */
 export class StorageControlClient {
   private _terminated = false;

packages/google-storage-control/tsconfig.json

@@ -7,7 +7,8 @@
     "lib": [
       "es2023",
       "dom"
-    ]
+    ],
+    "stripInternal": false
   },
   "include": [
     "src/*.ts",