From 88c3c72c97d682c95a5b7568a7aecf4521797fc5 Mon Sep 17 00:00:00 2001 From: Andrew Meyer Date: Fri, 7 Jul 2023 16:11:15 +0200 Subject: [PATCH] Trim the output of TypeDoc --- packages/realm-react/src/index.tsx | 3 +++ packages/realm/typedoc.json | 3 +++ 2 files changed, 6 insertions(+) diff --git a/packages/realm-react/src/index.tsx b/packages/realm-react/src/index.tsx index 7f09423dfb..35faee8e0d 100644 --- a/packages/realm-react/src/index.tsx +++ b/packages/realm-react/src/index.tsx @@ -209,6 +209,9 @@ export const useQuery = defaultContext.useQuery; */ export const useObject = defaultContext.useObject; +/* + * @ignore This will end up documenting all of Realm, which is documented elsewhere + */ export { Realm }; export * from "./AppProvider"; export { useUser, UserProvider } from "./UserProvider"; diff --git a/packages/realm/typedoc.json b/packages/realm/typedoc.json index 19274aadba..180e37cd0f 100644 --- a/packages/realm/typedoc.json +++ b/packages/realm/typedoc.json @@ -2,6 +2,9 @@ "entryPoints": ["src/index.ts"], "tsconfig": "./tsconfig.json", "excludeInternal": true, + "excludePrivate": true, + "excludeReferences": true, + "excludeNotDocumented": true, "customCss": "../../typedoc/style.css", "media": "../../media", "name": "Realm JavaScript",