docs(typedoc): update typedoc version

tuan231195 · Jan 12, 2021 · 78089d5 · 78089d5
1 parent 03cef42
commit 78089d5
Show file tree

Hide file tree

Showing 5 changed files with 129 additions and 118 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -52,8 +52,8 @@
         "tslint": "5.18.0",
         "tslint-config-prettier": "1.18.0",
         "tslint-plugin-prettier": "2.0.1",
-        "typedoc": "0.15.0",
-        "typescript": "3.5.3",
+        "typedoc": "^0.20.14",
+        "typescript": "^4.1.3",
         "yup": "0.27.0"
     },
     "files": [

diff --git a/src/index.ts b/src/index.ts
@@ -70,9 +70,9 @@ export function is(schema: Schema<any>): PropertyDecorator {
 
 /**
  * Register an array property
- * @param typeFunction: a function that returns type of the element
- * @param arraySchema: the array schema
- * @param elementSchema: an optional object schema
+ * @param typeFunction a function that returns type of the element
+ * @param arraySchema the array schema
+ * @param elementSchema an optional object schema
  */
 export function nestedArray(
     typeFunction: () => any,
@@ -96,8 +96,8 @@ export function nestedArray(
 
 /**
  * Register an object schema to the given property. Use this when the property type is unknown
- * @param typeFunction:  a function that returns type of the element
- * @param objectSchema: an optional object schema
+ * @param typeFunction  a function that returns type of the element
+ * @param objectSchema an optional object schema
  */
 export function nestedType(
     typeFunction: () => any,
@@ -122,7 +122,7 @@ export function nestedType(
 
 /**
  * Register an object schema to the given property. Use this when the property type is known and can be extracted using reflect-metadata
- * @param objectSchema: an optional object schema
+ * @param objectSchema an optional object schema
  *
  */
 export function nested(objectSchema?: ObjectSchema<any>): PropertyDecorator {

diff --git a/tsconfig.json b/tsconfig.json
@@ -21,14 +21,5 @@
         "./dist",
         "./test",
         "./index.d.ts"
-    ],
-    "typedocOptions": {
-        "mode": "modules",
-        "out": "docs",
-        "excludePrivate": true,
-        "excludeProtected": true,
-        "excludeNotExported": true,
-        "excludeExternals": true,
-        "toc": true
-    }
+    ]
 }
diff --git a/typedoc.json b/typedoc.json
@@ -0,0 +1,10 @@
+{
+  "out": "docs",
+  "excludePrivate": true,
+  "excludeProtected": true,
+  "excludeExternals": true,
+  "entryPoints": [
+    "src/index.ts"
+  ],
+  "toc": true
+}