typedoc - npm Package Compare versions

Comparing version 0.23.1 to 0.23.2

dist/lib/converter/comments/index.js

@@ -38,5 +38,5 @@ "use strict";
 }
-function getComment(symbol, kind, config, logger, commentStyle) {
-    const comment = getCommentWithCache((0, discovery_1.discoverComment)(symbol, kind, logger, commentStyle), config, logger);
-    if (symbol.declarations?.some(ts.isSourceFile) && comment) {
+function getCommentImpl(commentSource, config, logger, moduleComment) {
+    const comment = getCommentWithCache(commentSource, config, logger);
+    if (moduleComment && comment) {
         // Module comment, make sure it is tagged with @packageDocumentation or @module.
@@ -49,3 +49,3 @@ // If it isn't then the comment applies to the first statement in the file, so throw it away.
     }
-    if (!symbol.declarations?.some(ts.isSourceFile) && comment) {
+    if (!moduleComment && comment) {
         // Ensure module comments are not attached to non-module reflections.
@@ -59,5 +59,8 @@ if (comment.hasModifier("@packageDocumentation") ||
 }
+function getComment(symbol, kind, config, logger, commentStyle) {
+    return getCommentImpl((0, discovery_1.discoverComment)(symbol, kind, logger, commentStyle), config, logger, symbol.declarations?.some(ts.isSourceFile) || false);
+}
 exports.getComment = getComment;
 function getSignatureComment(declaration, config, logger, commentStyle) {
-    return getCommentWithCache((0, discovery_1.discoverSignatureComment)(declaration, commentStyle), config, logger);
+    return getCommentImpl((0, discovery_1.discoverSignatureComment)(declaration, commentStyle), config, logger, false);
 }
@@ -64,0 +67,0 @@ exports.getSignatureComment = getSignatureComment;

dist/lib/converter/comments/parser.js

@@ -179,3 +179,3 @@ "use strict";
                 // Unmatched closing brace, generate a warning, and treat it as text.
-                warning(`Unmatched closing brace in comment`);
+                warning(`Unmatched closing brace`);
                 content.push({ kind: "text", text: next.text });
@@ -182,0 +182,0 @@ break;

dist/lib/converter/converter.d.ts

@@ -8,3 +8,3 @@ import * as ts from "typescript";
 import type { DocumentationEntryPoint } from "../utils/entry-point";
-import type { CommentParserConfig } from "./comments";
+import { CommentParserConfig } from "./comments";
 import type { CommentStyle } from "../utils/options/declaration";
@@ -11,0 +11,0 @@ /**

dist/lib/converter/converter.js

@@ -22,2 +22,3 @@ "use strict";
 const enum_1 = require("../utils/enum");
+const comments_1 = require("./comments");
 /**
@@ -99,2 +100,5 @@ * Compiles source files using TypeScript and converts compiler symbols to reflections.
             context.project.registerReflection(context.project, symbol);
+            context.project.comment =
+                symbol &&
+                    (0, comments_1.getComment)(symbol, context.project.kind, this.config, this.application.logger, this.commentStyle);
             context.trigger(Converter_1.EVENT_CREATE_DECLARATION, context.project);
@@ -101,0 +105,0 @@ moduleContext = context;

dist/lib/output/plugins/JavascriptIndexPlugin.js

@@ -55,2 +55,5 @@ "use strict";
             const boost = reflection.relevanceBoost ?? 1;
+            if (boost <= 0) {
+                continue;
+            }
             if (parent instanceof models_1.ProjectReflection) {
@@ -57,0 +60,0 @@ parent = undefined;

package.json

 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.23.1",
+  "version": "0.23.2",
   "homepage": "https://typedoc.org",
@@ -6,0 +6,0 @@ "main": "./dist/index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

986514

increased by0.04%

Lines of code

23323

increased by0.04%

No dependency changes