diff --git a/packages/client-documentation-generator/src/sdk-client-comment-update.ts b/packages/client-documentation-generator/src/sdk-client-comment-update.ts index 3f29ed16faec..b88872466a9a 100644 --- a/packages/client-documentation-generator/src/sdk-client-comment-update.ts +++ b/packages/client-documentation-generator/src/sdk-client-comment-update.ts @@ -25,7 +25,7 @@ export class SdkClientCommentUpdatePlugin extends ConverterComponent { } /** - * Update documentation block to exclude empty lines + * Update documentation block to exclude empty lines. */ private cleanEmptyCommentLines(comment: string): string { return comment.startsWith("/*") && comment.endsWith("*/") diff --git a/packages/client-documentation-generator/src/sdk-client-rename-project.ts b/packages/client-documentation-generator/src/sdk-client-rename-project.ts index 925853e56957..3f92f79d4a29 100644 --- a/packages/client-documentation-generator/src/sdk-client-rename-project.ts +++ b/packages/client-documentation-generator/src/sdk-client-rename-project.ts @@ -3,7 +3,7 @@ import { Component, RendererComponent } from "typedoc/dist/lib/output/components import { RendererEvent } from "typedoc/dist/lib/output/events"; /** - * Correct the package name in the navigator + * Correct the package name in the navigator. */ @Component({ name: "SdkClientRenameProject" }) export class SdkClientRenameProjectPlugin extends RendererComponent { diff --git a/packages/client-documentation-generator/src/sdk-client-toc-plugin.ts b/packages/client-documentation-generator/src/sdk-client-toc-plugin.ts index 25291d1bb618..e14bb321d535 100644 --- a/packages/client-documentation-generator/src/sdk-client-toc-plugin.ts +++ b/packages/client-documentation-generator/src/sdk-client-toc-plugin.ts @@ -5,7 +5,7 @@ import { PageEvent } from "typedoc/dist/lib/output/events"; import { NavigationItem } from "typedoc/dist/lib/output/models/NavigationItem"; /** - * Group the ToC for easier observability + * Group the ToC for easier observability. */ @Component({ name: "SdkClientTocPlugin" }) export class SdkClientTocPlugin extends RendererComponent { @@ -55,7 +55,7 @@ export class SdkClientTocPlugin extends RendererComponent { const { extendedTypes = [] } = model; return ( model.kindOf(ReflectionKind.Class) && - model.getFullName() !== "Client" && // Exclude the Smithy Client class + model.getFullName() !== "Client" && // Exclude the Smithy Client class. (model.name.endsWith("Client") /* Modular client like S3Client */ || (extendedTypes.length === 1 && (extendedTypes[0] as ReferenceType).name.endsWith("Client"))) /* Legacy client like S3 */ @@ -65,7 +65,7 @@ export class SdkClientTocPlugin extends RendererComponent { private isCommand(model: DeclarationReflection): boolean { return ( model.kindOf(ReflectionKind.Class) && - model.getFullName() !== "Command" && // Exclude the Smithy Command class + model.getFullName() !== "Command" && // Exclude the Smithy Command class. model.name.endsWith("Command") && model.children?.some((child) => child.name === "resolveMiddleware") ); @@ -127,7 +127,7 @@ export class SdkClientTocPlugin extends RendererComponent { } } }); - // Group commands and input/output interface of each command + // Group commands and input/output interface of each command. this.commandsNavigationItem?.children.sort((childA, childB) => childA.title.localeCompare(childB.title)); } } diff --git a/packages/core-packages-documentation-generator/package.json b/packages/core-packages-documentation-generator/package.json index 82667119cf94..957a7d2ce8c2 100644 --- a/packages/core-packages-documentation-generator/package.json +++ b/packages/core-packages-documentation-generator/package.json @@ -31,10 +31,10 @@ "typescript": "~4.0.2" }, "private": true, - "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/master/packages/client-documentation-generator", + "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/master/packages/core-packages-documentation-generator", "repository": { "type": "git", "url": "https://github.com/aws/aws-sdk-js-v3.git", - "directory": "packages/client-documentation-generator" + "directory": "packages/core-packages-documentation-generator" } } diff --git a/packages/core-packages-documentation-generator/src/index.ts b/packages/core-packages-documentation-generator/src/index.ts index e304328b7cf6..5e69e24259b1 100644 --- a/packages/core-packages-documentation-generator/src/index.ts +++ b/packages/core-packages-documentation-generator/src/index.ts @@ -3,12 +3,12 @@ import { ParameterType, PluginHost } from "typedoc/dist/lib/utils"; import { SdkIndexLinkClientPlugin } from "./sdk-index-link-client"; /** - * * @param pluginHost An instance of PluginHost. */ module.exports = function load(pluginHost: PluginHost) { const application = pluginHost.owner; - // Core packages doc generator plugins + + // Core packages doc generator plugins. application.options.addDeclaration({ name: "clientDocs", help: diff --git a/packages/core-packages-documentation-generator/src/sdk-index-link-client.ts b/packages/core-packages-documentation-generator/src/sdk-index-link-client.ts index b3710f38fd0b..933927e8b89f 100644 --- a/packages/core-packages-documentation-generator/src/sdk-index-link-client.ts +++ b/packages/core-packages-documentation-generator/src/sdk-index-link-client.ts @@ -25,7 +25,8 @@ export class SdkIndexLinkClientPlugin extends RendererComponent { onPageBegin(page: PageEvent) { const out = isAbsolute(this.out) ? this.out : resolve(PROJECT_ROOT, this.out); const clientDocs = isAbsolute(this.clientDocs) ? this.clientDocs : resolve(PROJECT_ROOT, this.clientDocs); - // Get relative path from core packages doc to clients' doc + + // Get relative path from core packages doc to clients' doc. const clientDocsPattern = relative(out, clientDocs); if (page.model === page.project) { // Entry point index.html and global.html page. @@ -36,11 +37,12 @@ export class SdkIndexLinkClientPlugin extends RendererComponent { const clientName = child.sources[0].fileName.split(sep)[1]; const clientDocDir = clientDocsPattern.replace(/{{CLIENT}}/g, clientName); child.url = join(clientDocDir, "index.html"); - //@ts-ignore attach temporary flag + // @ts-ignore attach temporary flag. child._skipRendering = true; }); } - // Skip rendering empty landing page for each client + + // Skip rendering empty landing page for each client. if (page.model._skipRendering) { page.preventDefault(); } diff --git a/packages/node-http-handler/tsconfig.json b/packages/node-http-handler/tsconfig.json deleted file mode 100644 index f31c61813366..000000000000 --- a/packages/node-http-handler/tsconfig.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "compilerOptions": { - "rootDir": "./src", - "outDir": "./dist/cjs", - "baseUrl": "." - }, - "extends": "../../tsconfig.cjs.json", - "include": ["src/"] -} diff --git a/packages/node-http-handler/typedoc.js b/packages/node-http-handler/typedoc.js deleted file mode 100644 index ed5c56f229bb..000000000000 --- a/packages/node-http-handler/typedoc.js +++ /dev/null @@ -1,14 +0,0 @@ -const { __esModule } = require("typedoc-plugin-lerna-packages/dist/plugin"); - -module.exports = { - exclude: ["**/node_modules/**", "./protocols/*.ts", "./e2e/*.ts", "./endpoints.ts"], - excludedNotExported: true, - excludePrivate: true, - hideGenerator: true, - ignoreCompilerErrors: true, - inputFiles: ["./index.ts"], - mode: "file", - out: "./docs", - theme: "minimal", - plugin: "@aws-sdk/client-documentation-generator", -}; diff --git a/tsconfig.json b/tsconfig.json index f1b76e78f9f2..d03036c5263f 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -33,7 +33,7 @@ "out": "docs", "exclude": ["**/node_modules/**", "**/*.spec.ts"], "excludeExternals": true, - "name": "AWS SDK v3", + "name": "AWS SDK for JavaScript v3", "ignoreCompilerErrors": true, "theme": "minimal", "hideGenerator": true,