docs() add comments for overloaded signatures

Author: kamilmysliwiec

packages/common/PACKAGE.md

@@ -1 +1 @@
-The common package comes with decorators such as `@Controller()`, `@Injectable` and so on.
+The common package comes with decorators such as `@Controller()`, `@Injectable()` and so on.

packages/common/decorators/core/controller.decorator.ts

@@ -17,9 +17,6 @@ export interface ControllerOptions extends ScopeOptions {
   path?: string;
 }
 
-export function Controller();
-export function Controller(prefix: string);
-export function Controller(options: ControllerOptions);
 /**
  * Decorator that marks a class as a Nest controller that can receive inbound
  * requests and produce responses.

packages/common/decorators/http/route-params.decorator.ts

@@ -170,10 +170,64 @@ export const Headers: (
   property?: string,
 ) => ParameterDecorator = createRouteParamDecorator(RouteParamtypes.HEADERS);
 
+/**
+ * Route handler parameter decorator. Extracts the `query`
+ * property from the `req` object and populates the decorated
+ * parameter with the value of `query`. May also apply pipes to the bound
+ * query parameter.
+ *
+ * For example:
+ * ```typescript
+ * async find(@Query('user') user: string)
+ * ```
+ *
+ * @param property name of single property to extract from the `query` object
+ * @param pipes one or more pipes to apply to the bound query parameter
+ *
+ * @see [Request object](https://docs.nestjs.com/controllers#request-object)
+ *
+ * @publicApi
+ */
 export function Query(): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the `query`
+ * property from the `req` object and populates the decorated
+ * parameter with the value of `query`. May also apply pipes to the bound
+ * query parameter.
+ *
+ * For example:
+ * ```typescript
+ * async find(@Query('user') user: string)
+ * ```
+ *
+ * @param property name of single property to extract from the `query` object
+ * @param pipes one or more pipes to apply to the bound query parameter
+ *
+ * @see [Request object](https://docs.nestjs.com/controllers#request-object)
+ *
+ * @publicApi
+ */
 export function Query(
   ...pipes: (Type<PipeTransform> | PipeTransform)[]
 ): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the `query`
+ * property from the `req` object and populates the decorated
+ * parameter with the value of `query`. May also apply pipes to the bound
+ * query parameter.
+ *
+ * For example:
+ * ```typescript
+ * async find(@Query('user') user: string)
+ * ```
+ *
+ * @param property name of single property to extract from the `query` object
+ * @param pipes one or more pipes to apply to the bound query parameter
+ *
+ * @see [Request object](https://docs.nestjs.com/controllers#request-object)
+ *
+ * @publicApi
+ */
 export function Query(
   property: string,
   ...pipes: (Type<PipeTransform> | PipeTransform)[]
@@ -300,10 +354,82 @@ export function Body(
   );
 }
 
+/**
+ * Route handler parameter decorator. Extracts the `params`
+ * property from the `req` object and populates the decorated
+ * parameter with the value of `params`. May also apply pipes to the bound
+ * parameter.
+ *
+ * For example, extracting all params:
+ * ```typescript
+ * findOne(@Param() params: string[])
+ * ```
+ *
+ * For example, extracting a single param:
+ * ```typescript
+ * findOne(@Param('id') id: string)
+ * ```
+ * @param property name of single property to extract from the `req` object
+ * @param pipes one or more pipes - either instances or classes - to apply to
+ * the bound parameter.
+ *
+ * @see [Request object](https://docs.nestjs.com/controllers#request-object)
+ * @see [Working with pipes](https://docs.nestjs.com/custom-decorators#working-with-pipes)
+ *
+ * @publicApi
+ */
 export function Param(): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the `params`
+ * property from the `req` object and populates the decorated
+ * parameter with the value of `params`. May also apply pipes to the bound
+ * parameter.
+ *
+ * For example, extracting all params:
+ * ```typescript
+ * findOne(@Param() params: string[])
+ * ```
+ *
+ * For example, extracting a single param:
+ * ```typescript
+ * findOne(@Param('id') id: string)
+ * ```
+ * @param property name of single property to extract from the `req` object
+ * @param pipes one or more pipes - either instances or classes - to apply to
+ * the bound parameter.
+ *
+ * @see [Request object](https://docs.nestjs.com/controllers#request-object)
+ * @see [Working with pipes](https://docs.nestjs.com/custom-decorators#working-with-pipes)
+ *
+ * @publicApi
+ */
 export function Param(
   ...pipes: (Type<PipeTransform> | PipeTransform)[]
 ): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the `params`
+ * property from the `req` object and populates the decorated
+ * parameter with the value of `params`. May also apply pipes to the bound
+ * parameter.
+ *
+ * For example, extracting all params:
+ * ```typescript
+ * findOne(@Param() params: string[])
+ * ```
+ *
+ * For example, extracting a single param:
+ * ```typescript
+ * findOne(@Param('id') id: string)
+ * ```
+ * @param property name of single property to extract from the `req` object
+ * @param pipes one or more pipes - either instances or classes - to apply to
+ * the bound parameter.
+ *
+ * @see [Request object](https://docs.nestjs.com/controllers#request-object)
+ * @see [Working with pipes](https://docs.nestjs.com/custom-decorators#working-with-pipes)
+ *
+ * @publicApi
+ */
 export function Param(
   property: string,
   ...pipes: (Type<PipeTransform> | PipeTransform)[]

packages/common/interfaces/nest-application-options.interface.ts

@@ -1,13 +1,13 @@
+import { CorsOptions } from './external/cors-options.interface';
 import { HttpsOptions } from './external/https-options.interface';
 import { NestApplicationContextOptions } from './nest-application-context-options.interface';
-import { CorsOptions } from './external/cors-options.interface';
 
 /**
  * @publicApi
  */
 export interface NestApplicationOptions extends NestApplicationContextOptions {
   /**
-   * CORS options from [Express CORS package](https://github.com/expressjs/cors#configuration-options)
+   * CORS options from [CORS package](https://github.com/expressjs/cors#configuration-options)
    */
   cors?: boolean | CorsOptions;
   /**