docs(typedoc): logical modules for typedoc instead of file based

Author: mumenthalers

doc-intro.md

@@ -28,7 +28,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "build": "tsc --outDir ./dist/_esm2015/ && tsc --outDir ./dist/_esm5/ --target es5 && tsc --outDir ./dist/ --module commonjs",
-    "build:docs": "typedoc --out dist/docs --target es6 --theme minimal",
+    "build:docs": "rimraf ./dist/docs && typedoc --out dist/docs --readme ./doc-intro.md --target es6 --hideGenerator --theme minimal --excludePrivate --stripInternal",
     "check-snippets": "npx tsc --outDir ./dist-snippets --project ./snippets/tsconfig.json && rimraf dist-snippets",
     "commity": "commit",
     "deploy-docs": "ts-node tools/gh-pages-publish",
@@ -73,6 +73,7 @@
     "tslint-config-prettier": "^1.17.0",
     "tsutils": "^3.6.0",
     "typedoc": "^0.13.0",
+    "typedoc-plugin-external-module-name": "^2.0.0",
     "typescript": ">=2.9.1",
     "uuid": "^3.3.2"
   },

package-lock.json

@@ -1,3 +1,6 @@
+/**
+ * @module dynamo-easy
+ */
 import { SessionValidityEnsurer } from '../dynamo/session-validity-ensurer.type'
 import { TableNameResolver } from '../dynamo/table-name-resolver.type'
 import { LogReceiver } from '../logger/log-receiver.type'

package.json

@@ -1,3 +1,6 @@
+/**
+ * @module dynamo-easy
+ */
 import { DEFAULT_SESSION_VALIDITY_ENSURER } from '../dynamo/default-session-validity-ensurer.const'
 import { DEFAULT_TABLE_NAME_RESOLVER } from '../dynamo/default-table-name-resolver.const'
 import { DEFAULT_LOG_RECEIVER } from '../logger/default-log-receiver.const'

src/config/config.type.ts

@@ -1,3 +1,6 @@
+/**
+ * @module dynamo-easy
+ */
 export * from './config.type'
 export * from './update-config.function'
 

src/config/dynamo-easy-config.ts

@@ -1,3 +1,6 @@
+/**
+ * @module dynamo-easy
+ */
 import { Config } from './config.type'
 import { dynamoEasyConfig } from './dynamo-easy-config'
 

src/config/public-api.ts

@@ -1,3 +1,6 @@
+/**
+ * @module decorators
+ */
 import { MapperForType } from '../../../mapper/for-type/base.mapper'
 import { BinaryAttribute, NumberAttribute, StringAttribute } from '../../../mapper/type/attribute.type'
 import { ModelConstructor } from '../../../model/model-constructor'

src/config/update-config.function.ts

@@ -1,3 +1,6 @@
+/**
+ * @module decorators
+ */
 import { MapperForType } from '../../../mapper/for-type/base.mapper'
 import { BinaryAttribute, NumberAttribute, StringAttribute } from '../../../mapper/type/attribute.type'
 import {

src/decorator/impl/collection/collection-property-data.model.ts

@@ -1,3 +1,6 @@
+/**
+ * @module decorators
+ */
 /**
  * Option interface for @DateProperty decorator
  */