Fix JSDoc property comments

Resolves #2020

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Unreleased
 
+### Bug Fixes
+
+-   Fixed schema URL for TSDoc preventing the use of `typedoc/tsdoc.json` in TSDoc extends, #2016.
+-   Fixed missing JSDoc style `@typedef` comments for properties, #2020.
+
 ## v0.23.9 (2022-07-24)
 
 ### Bug Fixes

src/lib/converter/comments/index.ts

@@ -13,6 +13,14 @@ export interface CommentParserConfig {
     modifierTags: Set<string>;
 }
 
+const jsDocCommentKinds = [
+    ts.SyntaxKind.JSDocPropertyTag,
+    ts.SyntaxKind.JSDocCallbackTag,
+    ts.SyntaxKind.JSDocTypedefTag,
+    ts.SyntaxKind.JSDocTemplateTag,
+    ts.SyntaxKind.JSDocEnumTag,
+];
+
 const commentCache = new WeakMap<ts.SourceFile, Map<number, Comment>>();
 
 function getCommentWithCache(
@@ -95,6 +103,18 @@ export function getComment(
     logger: Logger,
     commentStyle: CommentStyle
 ): Comment | undefined {
+    if (
+        symbol
+            .getDeclarations()
+            ?.every((d) => jsDocCommentKinds.includes(d.kind))
+    ) {
+        return getJsDocComment(
+            symbol.declarations![0] as ts.JSDocPropertyLikeTag,
+            config,
+            logger
+        );
+    }
+
     return getCommentImpl(
         discoverComment(symbol, kind, logger, commentStyle),
         config,
@@ -191,6 +211,6 @@ export function getJsDocComment(
             declaration
         );
     } else {
-        return new Comment(tag.content.slice());
+        return new Comment(Comment.cloneDisplayParts(tag.content));
     }
 }

src/test/converter/js/specs.json

@@ -201,6 +201,14 @@
               "kind": 1024,
               "kindString": "Property",
               "flags": {},
+              "comment": {
+                "summary": [
+                  {
+                    "kind": "text",
+                    "text": "can also use prop tag"
+                  }
+                ]
+              },
               "sources": [
                 {
                   "fileName": "index.js",
@@ -220,6 +228,14 @@
               "kind": 1024,
               "kindString": "Property",
               "flags": {},
+              "comment": {
+                "summary": [
+                  {
+                    "kind": "text",
+                    "text": "docs for property"
+                  }
+                ]
+              },
               "sources": [
                 {
                   "fileName": "index.js",
@@ -265,6 +281,14 @@
               "kind": 1024,
               "kindString": "Property",
               "flags": {},
+              "comment": {
+                "summary": [
+                  {
+                    "kind": "text",
+                    "text": "docs for property\nmore docs for property"
+                  }
+                ]
+              },
               "sources": [
                 {
                   "fileName": "index.js",

src/test/converter2/issues/gh2020.js

@@ -0,0 +1,7 @@
+// @ts-check
+
+/**
+ * @typedef {Object} Options Desc
+ * @property {string} url - Desc2
+ * @property {string} [apiKey] - Desc3
+ */

src/test/issueTests.ts

@@ -678,4 +678,21 @@ export const issueTests: {
         equal(model.getAlias(), "model");
         equal(Model.getAlias(), "Model-1");
     },
+
+    gh2020(project) {
+        const opt = query(project, "Options");
+        equal(Comment.combineDisplayParts(opt.comment?.summary), "Desc");
+        equal(
+            Comment.combineDisplayParts(
+                opt.getChildByName("url")?.comment?.summary
+            ),
+            "Desc2"
+        );
+        equal(
+            Comment.combineDisplayParts(
+                opt.getChildByName("apiKey")?.comment?.summary
+            ),
+            "Desc3"
+        );
+    },
 };