Small Documentation Tweak

scripts/documentation/index.js

@@ -43,6 +43,10 @@ function getApiPath(somePath) {
  apiPath = apiPath.replace(/\//gm, '.').replace('shared.', 'AthenaShared.');
  }
 
+ if (apiPath.includes('..')) {
+ apiPath = apiPath.replace(/\.\./gm, '.');
+ }
+
  return apiPath;
 }
 
@@ -51,12 +55,13 @@ for (let file of files) {
  continue;
  }
 
- if (file.includes('internal')) {
- continue;
- }
-
  const apiPath = getApiPath(file);
  const rows = fs.readFileSync(file).toString().split('\n');
+ if (rows.length <= 3) {
+ console.log(`Deleting Dead File: ${file}`);
+ fs.rmSync(file);
+ continue;
+ }
 
  // Remove first row, since the title sucks
  rows.shift();

src/core/shared/utility/knownKeys.ts

@@ -1,13 +1,22 @@
+/**
+ * @ignore
+ */
 export type KnownKeys<T> = {
  [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K];
 };
 
+/**
+ * @ignore
+ */
 export type OmitFromKnownKeys<T, K extends keyof T> = KnownKeys<T> extends infer U
  ? keyof U extends keyof T
  ? Pick<T, Exclude<keyof U, K>> & Pick<T, Exclude<keyof T, keyof KnownKeys<T>>>
  : never
  : never;
 
+/**
+ * @ignore
+ */
 export type RemoveIndex<T> = {
  [P in keyof T as string extends P ? never : number extends P ? never : P]: T[P];
 };

src/core/shared/utility/requiredFields.ts

@@ -1 +1,4 @@
+/**
+ * @ignore
+ */
 export type RequireFields<T, K extends keyof T> = T & Required<Pick<T, K>>;

src/core/typedoc.json

@@ -4,7 +4,7 @@
  "out": "../../docs",
  "skipErrorChecking": true,
  "tsconfig": "./custom.json",
- "plugin": ["typedoc-plugin-external-resolver", "typedoc-plugin-missing-exports", "typedoc-plugin-markdown"],
+ "plugin": ["typedoc-plugin-missing-exports", "typedoc-plugin-markdown"],
  "theme": "markdown",
  "basePath": "./",
  "entryPointStrategy": "expand",
@@ -15,5 +15,6 @@
  "hideInPageTOC": true,
  "hideMembersSymbol": false,
  "objectLiteralTypeDeclarationStyle": "table",
- "filenameSeparator": "_"
+ "filenameSeparator": "_",
+ "internalModule": "Internal"
 }