fix: Add comments for function type properties (#281)

typedoc2md · Jan 9, 2022 · c38a095 · c38a095
1 parent 5f2ef42
commit c38a095
Showing 1 changed file with 10 additions and 4 deletions.
diff --git a/packages/typedoc-plugin-markdown/src/resources/helpers/property-table.ts b/packages/typedoc-plugin-markdown/src/resources/helpers/property-table.ts
@@ -61,11 +61,10 @@ export default function () {
         );
 
         if (hasComments) {
-          if (property.comment) {
+          const comments = getComments(property);
+          if (comments) {
             row.push(
-              stripLineBreaks(
-                Handlebars.helpers.comments.call(property.comment),
-              ),
+              stripLineBreaks(Handlebars.helpers.comments.call(comments)),
             );
           } else {
             row.push('-');
@@ -112,3 +111,10 @@ function getName(property: DeclarationReflection) {
   }
   return md.join('');
 }
+
+function getComments(property: DeclarationReflection) {
+  if (property.signatures) {
+    return property.signatures[0].comment;
+  }
+  return property.comment;
+}