fix(core): expose missing descriptions with accessor keyword (#664)

typedoc2md · Aug 15, 2024 · 5be8459 · 5be8459
1 parent 7afe341
commit 5be8459
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 2 deletions.
diff --git a/.changeset/nine-experts-vanish.md b/.changeset/nine-experts-vanish.md
@@ -0,0 +1,5 @@
+---
+'typedoc-plugin-markdown': patch
+---
+
+- Expose missing descriptions with accessor keyword (#664)
diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.accessor.ts
@@ -60,7 +60,7 @@ export function accessor(
     );
   }
 
-  if (model.comment?.blockTags?.length) {
+  if (model.comment) {
     md.push(
       this.partials.comment(model.comment, {
         headingLevel: options.headingLevel,

diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/classes.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/classes.ts
@@ -272,7 +272,6 @@ export class ClassWithAccessorKeywords {
    * const x = 1;
    * ```
    */
-
   public accessor accessor1: string;
 
   /**
@@ -281,4 +280,9 @@ export class ClassWithAccessorKeywords {
    * @remarks Remark comments
    */
   public accessor accessor2: string;
+
+  /**
+   * Accessor comments
+   */
+  public accessor accessor3: string;
 }
diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap
@@ -223,6 +223,16 @@ Remark comments
 
 #### Source
 
+[classes.ts:1](http://source-url)
+
+***
+
+### accessor3
+
+Accessor comments
+
+#### Source
+
 [classes.ts:1](http://source-url)
 "
 `;