From f88cc8846b2f25a66335a346a8aa330c69fa120f Mon Sep 17 00:00:00 2001
From: Joel Low <joel.low@grabtaxi.com>
Date: Tue, 6 Oct 2020 09:04:05 +0800
Subject: [PATCH] Add missing @param declarations in API docs

---
 .../backend-common/src/database/SingleConnection.ts    |  4 ++++
 packages/backend-common/src/database/config.ts         |  2 +-
 packages/backend-common/src/database/types.ts          | 10 ++++++----
 3 files changed, 11 insertions(+), 5 deletions(-)

diff --git a/packages/backend-common/src/database/SingleConnection.ts b/packages/backend-common/src/database/SingleConnection.ts
index c34c3a8310..aa2e2186b5 100644
--- a/packages/backend-common/src/database/SingleConnection.ts
+++ b/packages/backend-common/src/database/SingleConnection.ts
@@ -31,6 +31,8 @@ export class SingleConnectionDatabaseManager {
    * Creates a new SingleConnectionDatabaseManager instance by reading from the `backend`
    * config section, specifically the `.database` key for discovering the management
    * database configuration.
+   *
+   * @param config The loaded application configuration.
    */
   static fromConfig(config: Config): SingleConnectionDatabaseManager {
     return new SingleConnectionDatabaseManager(
@@ -52,6 +54,8 @@ export class SingleConnectionDatabaseManager {
 
   /**
    * Generates a PluginDatabaseManager for consumption by plugins.
+   *
+   * @param pluginId The plugin that the database manager should be created for. Plugin names should be unique.
    */
   forPlugin(pluginId: string): PluginDatabaseManager {
     const _this = this;
diff --git a/packages/backend-common/src/database/config.ts b/packages/backend-common/src/database/config.ts
index a16cf6cbee..af32556c28 100644
--- a/packages/backend-common/src/database/config.ts
+++ b/packages/backend-common/src/database/config.ts
@@ -19,7 +19,7 @@ import { merge } from 'lodash';
 /**
  * Merges database objects together
  *
- * @param config The base config
+ * @param config The base config. The input is not modified
  * @param overrides Any additional overrides
  */
 export function mergeDatabaseConfig(config: any, ...overrides: any[]) {
diff --git a/packages/backend-common/src/database/types.ts b/packages/backend-common/src/database/types.ts
index 915a12a24e..5705d8ae5f 100644
--- a/packages/backend-common/src/database/types.ts
+++ b/packages/backend-common/src/database/types.ts
@@ -24,10 +24,12 @@ export interface PluginDatabaseManager {
    * getClient provides backend plugins database connections for itself.
    *
    * The purpose of this method is to allow plugins to get isolated data
-   * stores so that plugins are discouraged from database integration. Plugins
-   * can omit the `database` parameter to get the default plugin database, or
-   * provide an identifier that will be used to identify a separate database
-   * from the default.
+   * stores so that plugins are discouraged from database integration.
+   *
+   * @param database This parameter can be omitted to get the default plugin
+   * database, or provide an identifier that will be used to identify a
+   * separate database from the default to connect to. This can be used for
+   * application-level sharding.
    */
   getClient(database?: string): Promise<knex>;
 }