More clean up and links

elastic · May 12, 2021 · 1e8ae1f · 1e8ae1f
1 parent c7fc90e
commit 1e8ae1f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/x-pack/plugins/cases/docs/README.md b/x-pack/plugins/cases/docs/README.md
@@ -4,6 +4,11 @@ This directory contains generated docs using `typedoc` for the cases client API
 plugins. This README will describe how to generate a new version of these markdown docs in the event that new methods
 or parameters are added.
 
+## TypeDoc Info
+
+See more info at: <https://typedoc.org/>
+and: <https://www.npmjs.com/package/typedoc-plugin-markdown> for the markdown plugin
+
 ## Install dependencies
 
 ```bash

diff --git a/x-pack/plugins/cases/server/plugin.ts b/x-pack/plugins/cases/server/plugin.ts
@@ -51,14 +51,13 @@ export interface PluginsStart {
 
 /**
  * Cases server exposed contract for interacting with cases entities.
- *
- * @public
  */
 export interface PluginsStartContract {
   /**
    * Returns a client which can be used to interact with the cases backend entities.
    *
    * @param request a KibanaRequest
+   * @returns a {@link CasesClient}
    */
   getCasesClientWithRequest(request: KibanaRequest): Promise<CasesClient>;
 }