feat(platform-express): Add documentation for public API

packages/platform-express/interfaces/nest-express-application.interface.ts

@@ -1,59 +1,76 @@
 import { INestApplication } from '@nestjs/common';
 import { ServeStaticOptions } from './serve-static-options.interface';
 
+/**
+ * Interface describing methods on NestExpressApplication.
+ *
+ * @see [Platform](https://docs.nestjs.com/first-steps#platform)
+ *
+ * @publicApi
+ */
 export interface NestExpressApplication extends INestApplication {
   /**
    * A wrapper function around native `express.set()` method.
-   * Example `app.set('trust proxy', 'loopback')`
+   *
+   * @example
+   * app.set('trust proxy', 'loopback')
    *
    * @returns {this}
    */
   set(...args: any[]): this;
 
   /**
    * A wrapper function around native `express.engine()` method.
-   * Example `app.engine('mustache', mustacheExpress())`
+   * @example
+   * app.engine('mustache', mustacheExpress())
    *
    * @returns {this}
    */
   engine(...args: any[]): this;
 
   /**
    * A wrapper function around native `express.enable()` method.
-   * Example `app.enable('x-powered-by')`
+   * @example
+   * app.enable('x-powered-by')
    *
    * @returns {this}
    */
   enable(...args: any[]): this;
 
   /**
    * A wrapper function around native `express.disable()` method.
-   * Example `app.disable('x-powered-by')`
+   *
+   * @example
+   * app.disable('x-powered-by')
    *
    * @returns {this}
    */
   disable(...args: any[]): this;
 
+  useStaticAssets(options: ServeStaticOptions): this;
   /**
    * Sets a base directory for public assets.
-   * Example `app.useStaticAssets('public')
+   * @example
+   * app.useStaticAssets('public')
    *
    * @returns {this}
    */
-  useStaticAssets(options: ServeStaticOptions): this;
   useStaticAssets(path: string, options?: ServeStaticOptions): this;
 
   /**
    * Sets one or multiple base directories for templates (views).
-   * Example `app.setBaseViewsDir('views')`
+   *
+   * @example
+   * app.setBaseViewsDir('views')
    *
    * @returns {this}
    */
   setBaseViewsDir(path: string | string[]): this;
 
   /**
    * Sets a view engine for templates (views).
-   * Example `app.setViewEngine('pug')`
+   * @example
+   * app.setViewEngine('pug')
    *
    * @returns {this}
    */

packages/platform-express/interfaces/serve-static-options.interface.ts

@@ -1,5 +1,10 @@
 /**
- * @see https://www.npmjs.com/package/@types/serve-static
+ * Interface describing options for serving static assets.
+ *
+ * @see [Serving static files in Express](https://expressjs.com/en/starter/static-files.html)
+ * @see [Model-View-Controller](https://docs.nestjs.com/techniques/mvc)
+ *
+ * @publicApi
  */
 export interface ServeStaticOptions {
   /**
@@ -60,10 +65,10 @@ export interface ServeStaticOptions {
 
   /**
    * Function to set custom headers on response. Alterations to the headers need to occur synchronously.
-   * The function is called as fn(res, path, stat), where the arguments are:
-   * res the response object
-   * path the file path that is being sent
-   * stat the stat object of the file that is being sent
+   * The function is called as `fn(res, path, stat)`, where the arguments are:
+   * `res` - the response object
+   * `path` - the file path that is being sent
+   * `stat` - the stat object of the file that is being sent
    */
   setHeaders?: (res: any, path: string, stat: any) => any;