docs: fix various tsdoc tags (#1481)

* docs: fix various tsdoc tags

* set changeset to empty

Author: kuhe

.changeset/proud-bats-unite.md

@@ -0,0 +1,2 @@
+---
+---

packages/config-resolver/src/endpointsConfig/resolveCustomEndpointsConfig.ts

@@ -13,6 +13,9 @@ export interface CustomEndpointsInputConfig extends EndpointsInputConfig {
   endpoint: string | Endpoint | Provider<Endpoint>;
 }
 
+/**
+ * @internal
+ */
 interface PreviouslyResolved {
   urlParser: UrlParser;
 }

packages/config-resolver/src/endpointsConfig/resolveEndpointsConfig.ts

@@ -24,6 +24,9 @@ export interface EndpointsInputConfig {
   useDualstackEndpoint?: boolean | Provider<boolean>;
 }
 
+/**
+ * @internal
+ */
 interface PreviouslyResolved {
   regionInfoProvider: RegionInfoProvider;
   urlParser: UrlParser;
@@ -55,7 +58,7 @@ export interface EndpointsResolvedConfig extends Required<EndpointsInputConfig>
 /**
  * @internal
  *
- * @deprecated endpoints rulesets use @smithy/middleware-endpoint resolveEndpointConfig.
+ * @deprecated endpoints rulesets use \@smithy/middleware-endpoint resolveEndpointConfig.
  * All generated clients should migrate to Endpoints 2.0 endpointRuleSet traits.
  */
 export const resolveEndpointsConfig = <T>(

packages/eventstream-serde-config-resolver/src/EventStreamSerdeConfig.ts

@@ -12,6 +12,9 @@ export interface EventStreamSerdeResolvedConfig {
   eventStreamMarshaller: EventStreamMarshaller;
 }
 
+/**
+ * @internal
+ */
 interface PreviouslyResolved {
   /**
    * Provide the event stream marshaller for the given runtime

packages/fetch-http-handler/src/fetch-http-handler.ts

@@ -8,10 +8,11 @@ import { requestTimeout } from "./request-timeout";
 
 declare let AbortController: any;
 
+/**
+ * @public
+ */
 export { FetchHttpHandlerOptions };
 
-type FetchHttpHandlerConfig = FetchHttpHandlerOptions;
-
 /**
  * @internal
  * Detection of keepalive support. Can be overridden for testing.
@@ -35,9 +36,9 @@ export type AdditionalRequestParameters = {
  *
  * HttpHandler implementation using browsers' `fetch` global function.
  */
-export class FetchHttpHandler implements HttpHandler<FetchHttpHandlerConfig> {
-  private config?: FetchHttpHandlerConfig;
-  private configProvider: Promise<FetchHttpHandlerConfig>;
+export class FetchHttpHandler implements HttpHandler<FetchHttpHandlerOptions> {
+  private config?: FetchHttpHandlerOptions;
+  private configProvider: Promise<FetchHttpHandlerOptions>;
 
   /**
    * @returns the input if it is an HttpHandler of any class,
@@ -51,7 +52,7 @@ export class FetchHttpHandler implements HttpHandler<FetchHttpHandlerConfig> {
       return instanceOrOptions as HttpHandler<any>;
     }
     // input is ctor options or undefined.
-    return new FetchHttpHandler(instanceOrOptions as FetchHttpHandlerConfig);
+    return new FetchHttpHandler(instanceOrOptions as FetchHttpHandlerOptions);
   }
 
   constructor(options?: FetchHttpHandlerOptions | Provider<FetchHttpHandlerOptions | void>) {
@@ -199,15 +200,15 @@ export class FetchHttpHandler implements HttpHandler<FetchHttpHandlerConfig> {
     return Promise.race(raceOfPromises).finally(removeSignalEventListener);
   }
 
-  updateHttpClientConfig(key: keyof FetchHttpHandlerConfig, value: FetchHttpHandlerConfig[typeof key]): void {
+  updateHttpClientConfig(key: keyof FetchHttpHandlerOptions, value: FetchHttpHandlerOptions[typeof key]): void {
     this.config = undefined;
     this.configProvider = this.configProvider.then((config) => {
       (config as Record<typeof key, typeof value>)[key] = value;
       return config;
     });
   }
 
-  httpHandlerConfigs(): FetchHttpHandlerConfig {
+  httpHandlerConfigs(): FetchHttpHandlerOptions {
     return this.config ?? {};
   }
 }

packages/middleware-endpoint/src/resolveEndpointConfig.ts

@@ -51,6 +51,9 @@ export interface EndpointInputConfig<T extends EndpointParameters = EndpointPara
   serviceConfiguredEndpoint?: never;
 }
 
+/**
+ * @internal
+ */
 interface PreviouslyResolved<T extends EndpointParameters = EndpointParameters> {
   urlParser: UrlParser;
   region: Provider<string>;
@@ -63,7 +66,7 @@ interface PreviouslyResolved<T extends EndpointParameters = EndpointParameters>
  * @internal
  *
  * This supercedes the similarly named EndpointsResolvedConfig (no parametric types)
- * from resolveEndpointsConfig.ts in @smithy/config-resolver.
+ * from resolveEndpointsConfig.ts in \@smithy/config-resolver.
  */
 export interface EndpointResolvedConfig<T extends EndpointParameters = EndpointParameters> {
   /**

packages/middleware-retry/src/AdaptiveRetryStrategy.ts

@@ -4,13 +4,15 @@ import { DefaultRateLimiter, RateLimiter, RETRY_MODES } from "@smithy/util-retry
 import { StandardRetryStrategy, StandardRetryStrategyOptions } from "./StandardRetryStrategy";
 
 /**
+ * @public
  * Strategy options to be passed to AdaptiveRetryStrategy
  */
 export interface AdaptiveRetryStrategyOptions extends StandardRetryStrategyOptions {
   rateLimiter?: RateLimiter;
 }
 
 /**
+ * @public
  * @deprecated use AdaptiveRetryStrategy from @smithy/util-retry
  */
 export class AdaptiveRetryStrategy extends StandardRetryStrategy {

packages/middleware-retry/src/StandardRetryStrategy.ts

@@ -21,6 +21,8 @@ import { asSdkError } from "./util";
 
 /**
  * Strategy options to be passed to StandardRetryStrategy
+ * @public
+ * @deprecated use StandardRetryStrategy from @smithy/util-retry
  */
 export interface StandardRetryStrategyOptions {
   retryDecider?: RetryDecider;
@@ -29,6 +31,7 @@ export interface StandardRetryStrategyOptions {
 }
 
 /**
+ * @public
  * @deprecated use StandardRetryStrategy from @smithy/util-retry
  */
 export class StandardRetryStrategy implements RetryStrategy {

packages/middleware-retry/src/configurations.ts

@@ -9,9 +9,18 @@ import {
   StandardRetryStrategy,
 } from "@smithy/util-retry";
 
+/**
+ * @internal
+ */
 export const ENV_MAX_ATTEMPTS = "AWS_MAX_ATTEMPTS";
+/**
+ * @internal
+ */
 export const CONFIG_MAX_ATTEMPTS = "max_attempts";
 
+/**
+ * @internal
+ */
 export const NODE_MAX_ATTEMPT_CONFIG_OPTIONS: LoadedConfigSelectors<number> = {
   environmentVariableSelector: (env) => {
     const value = env[ENV_MAX_ATTEMPTS];
@@ -73,6 +82,9 @@ export interface RetryResolvedConfig {
   retryStrategy: Provider<RetryStrategyV2 | RetryStrategy>;
 }
 
+/**
+ * @internal
+ */
 export const resolveRetryConfig = <T>(input: T & PreviouslyResolved & RetryInputConfig): T & RetryResolvedConfig => {
   const { retryStrategy } = input;
   const maxAttempts = normalizeProvider(input.maxAttempts ?? DEFAULT_MAX_ATTEMPTS);
@@ -92,9 +104,19 @@ export const resolveRetryConfig = <T>(input: T & PreviouslyResolved & RetryInput
   };
 };
 
+/**
+ * @internal
+ */
 export const ENV_RETRY_MODE = "AWS_RETRY_MODE";
+
+/**
+ * @internal
+ */
 export const CONFIG_RETRY_MODE = "retry_mode";
 
+/**
+ * @internal
+ */
 export const NODE_RETRY_MODE_CONFIG_OPTIONS: LoadedConfigSelectors<string> = {
   environmentVariableSelector: (env) => env[ENV_RETRY_MODE],
   configFileSelector: (profile) => profile[CONFIG_RETRY_MODE],

packages/middleware-retry/src/defaultRetryQuota.ts

@@ -3,6 +3,9 @@ import { NO_RETRY_INCREMENT, RETRY_COST, TIMEOUT_RETRY_COST } from "@smithy/util
 
 import { RetryQuota } from "./types";
 
+/**
+ * @internal
+ */
 export interface DefaultRetryQuotaOptions {
   /**
    * The total amount of retry token to be incremented from retry token balance
@@ -22,6 +25,9 @@ export interface DefaultRetryQuotaOptions {
   timeoutRetryCost?: number;
 }
 
+/**
+ * @internal
+ */
 export const getDefaultRetryQuota = (initialRetryTokens: number, options?: DefaultRetryQuotaOptions): RetryQuota => {
   const MAX_CAPACITY = initialRetryTokens;
   const noRetryIncrement = options?.noRetryIncrement ?? NO_RETRY_INCREMENT;