From 1e8ae1f6ba4d6c66dc0dd7e603b66b254a3cfc3a Mon Sep 17 00:00:00 2001 From: Jonathan Buttner Date: Wed, 12 May 2021 14:44:11 -0400 Subject: [PATCH] More clean up and links --- x-pack/plugins/cases/docs/README.md | 5 +++++ x-pack/plugins/cases/server/plugin.ts | 3 +-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/x-pack/plugins/cases/docs/README.md b/x-pack/plugins/cases/docs/README.md index 413d883bc7b420..5b7e1b9b88e326 100644 --- 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: +and: 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 index ba495daa76ab8d..c9560bb82ded83 100644 --- 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; }