typedoc.json

{
  "$schema": "https://typedoc.org/schema.json",
  "blockTags": [
    "@param",
    "@returns",
    "@see",
    "@throws",
    "@version",
    "@description",
    "@deprecated",
    "@example",
    "@link",
    "@since",
    "@summary",
    "@todo",
    "@tutorial",
    "@ignore",
    "@private",
    "@protected",
    "@public",
    "@readonly",
    "@type",
    "@typedef",
    "@callback",
    "@class",
    "@constant",
    "@default",
    "@enum",
    "@export",
    "@external",
    "@file",
    "@fires",
    "@function",
    "@global",
    "@implements",
    "@instance",
    "@interface",
    "@kind",
    "@lends",
    "@license",
    "@member",
    "@memberof",
    "@mixes",
    "@mixin",
    "@module",
    "@name",
    "@namespace",
    "@override",
    "@package",
    "@property",
    "@prop",
    "@protected",
    "@public",
    "@readonly",
    "@requires",
    "@static",
    "@template",
    "@this",
    "@throws",
    "@type",
    "@var",
    "@yields",
    "@remarks"
  ],
  "cleanOutputDir": true,
  "commentStyle": "jsdoc",
  "customFooterHtml": "<span>Copyright <a href='https://ultimasolution.pl/>ultimasolution.pl</a> <a href='https://ultimasolution.pl/3d-inventory-mongo-api'>3d-inventory</a> 2024</span>",
  "customFooterHtmlDisableWrapper": false,
  "entryPointStrategy": "resolve",
  "entryPoints": [
    "./src/index.ts",
    "./src/routers/attributes.ts",
    "./src/routers/attributesDictionary.ts",
    "./src/routers/attributesTypes.ts",
    "./src/routers/componets.ts",
    "./src/routers/connections.ts",
    "./src/routers/devices.ts",
    "./src/routers/floors.ts",
    "./src/routers/generateTextures.ts",
    "./src/routers/github.ts",
    "./src/routers/github.test.ts",
    "./src/routers/logs.ts",
    "./src/routers/models.ts",
    "./src/routers/models.ts",
    "./src/routers/readme.ts",
    "./src/routers/users.ts",
    "./src/services/logs.ts",
    "./src/tests/generateTextures.test.js"
  ],
  "exclude": [
    "**/node_modules/**/*",
    "**/dist/**/*",
    "**/coverage/**/*"
  ],
  "includeVersion": true,
  "inlineTags": [
    "@version",
    "@link"
  ],
  "jsDocCompatibility": {
    "ignoreUnescapedBraces": true,
    "inheritDocTag": true
  },
  "name": "3d-inventory-mongo-api",
  "out": "./docs",
  "plugin": [
    "typedoc-plugin-mdn-links",
    "typedoc-plugin-missing-exports",
    "typedoc-plugin-merge-modules"
  ],
  "projectDocuments": [
    "README.md"
  ],
  "readme": "README.md",
  "resolveUtilityTypes": true,
  "theme": "default",
  "tsconfig": "./tsconfig.json",
  "modifierTags": [
    "@alpha",
    "@beta",
    "@experimental"
  ],
  "mergeModulesRenameDefaults": true,
  "mergeModulesMergeMode": "module",
}