typedoc 0.23.17 → 0.23.18

package/dist/lib/application.js

@@ -129,7 +129,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
         this.options.freeze();
         this.logger.verbose(`Using TypeScript ${this.getTypeScriptVersion()} from ${this.getTypeScriptPath()}`);
         if (!supportedVersionMajorMinor.some((version) => version == ts.versionMajorMinor)) {
-            this.logger.warn(`You are running with an unsupported TypeScript version! This may work, or it might break. TypeDoc supports ${supportedVersionMajorMinor.join(", ")}`);
+            this.logger.warn(`You are running with an unsupported TypeScript version! If TypeDoc crashes, this is why. TypeDoc supports ${supportedVersionMajorMinor.join(", ")}`);
         }
         const entryPoints = this.getEntryPoints();
         if (!entryPoints) {

package/dist/lib/converter/comments/index.js

@@ -64,9 +64,24 @@ function getComment(symbol, kind, config, logger, commentStyle) {
         ?.every((d) => jsDocCommentKinds.includes(d.kind))) {
         return getJsDocComment(symbol.declarations[0], config, logger);
     }
-    return getCommentImpl((0, discovery_1.discoverComment)(symbol, kind, logger, commentStyle), config, logger, symbol.declarations?.some(ts.isSourceFile) || false);
+    const comment = getCommentImpl((0, discovery_1.discoverComment)(symbol, kind, logger, commentStyle), config, logger, symbol.declarations?.some(ts.isSourceFile) || false);
+    if (!comment && kind === models_1.ReflectionKind.Property) {
+        return getConstructorParamPropertyComment(symbol, config, logger, commentStyle);
+    }
+    return comment;
 }
 exports.getComment = getComment;
+function getConstructorParamPropertyComment(symbol, config, logger, commentStyle) {
+    const decl = symbol.declarations?.find(ts.isParameter);
+    if (!decl)
+        return;
+    const ctor = decl.parent;
+    const comment = getSignatureComment(ctor, config, logger, commentStyle);
+    const paramTag = comment?.getIdentifiedTag(symbol.name, "@param");
+    if (paramTag) {
+        return new models_1.Comment(paramTag.content);
+    }
+}
 function getSignatureComment(declaration, config, logger, commentStyle) {
     return getCommentImpl((0, discovery_1.discoverSignatureComment)(declaration, commentStyle), config, logger, false);
 }

package/dist/lib/converter/types.js

@@ -413,7 +413,16 @@ const referenceConverter = {
             return models_1.ReferenceType.createBrokenReference(context.checker.typeToString(type), context.project);
         }
         const ref = models_1.ReferenceType.createSymbolReference(context.resolveAliasedSymbol(symbol), context);
-        ref.typeArguments = (type.aliasSymbol ? type.aliasTypeArguments : type.typeArguments)?.map((ref) => convertType(context, ref));
+        if (type.flags & ts.TypeFlags.StringMapping) {
+            ref.typeArguments = [
+                convertType(context, type.type),
+            ];
+        }
+        else {
+            ref.typeArguments = (type.aliasSymbol
+                ? type.aliasTypeArguments
+                : type.typeArguments)?.map((ref) => convertType(context, ref));
+        }
         return ref;
     },
 };

package/dist/lib/output/themes/default/partials/type.js

@@ -231,6 +231,18 @@ const typeRenderers = {
                     utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, ")")));
                 continue;
             }
+            if (item.signatures) {
+                for (const sig of item.signatures) {
+                    members.push(utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+                        item.name,
+                        item.flags.isOptional && utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "?"),
+                        context.memberSignatureTitle(sig, {
+                            hideName: true,
+                            arrowStyle: false,
+                        })));
+                }
+                continue;
+            }
             members.push(utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
                 item.name,
                 utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, item.flags.isOptional ? "?: " : ": "),

package/dist/lib/utils/entry-point.js

@@ -103,7 +103,7 @@ function getEntryPointsForPaths(logger, inputFiles, options, programs = getEntry
                 }
             }
         }
-        logger.warn(`Unable to locate entry point: ${fileOrDir}`);
+        logger.warn(`The entry point ${(0, paths_1.nicePath)(fileOrDir)} does not exist or is not included in the program for your provided tsconfig.`);
     }
     return entryPoints;
 }

package/dist/lib/utils/options/readers/tsconfig.js

@@ -11,6 +11,7 @@ const paths_1 = require("../../paths");
 const module_1 = require("module");
 const tsdoc_defaults_1 = require("../tsdoc-defaults");
 const array_1 = require("../../array");
+const entry_point_1 = require("../../entry-point");
 function isFile(file) {
     return (0, fs_1.existsSync)(file) && (0, fs_1.statSync)(file).isFile();
 }
@@ -74,6 +75,10 @@ class TSConfigReader {
             if (container.isSet("tsconfig")) {
                 logger.error(`The tsconfig file ${(0, paths_1.nicePath)(file)} does not exist`);
             }
+            else if (container.getValue("entryPointStrategy") !==
+                entry_point_1.EntryPointStrategy.Packages) {
+                logger.warn("No tsconfig file found, this will prevent TypeDoc from finding your entry points.");
+            }
             return;
         }
         fileToRead = (0, fs_2.normalizePath)((0, path_1.resolve)(fileToRead));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.23.17",
+  "version": "0.23.18",
   "homepage": "https://typedoc.org",
   "main": "./dist/index.js",
   "exports": {