typedoc-plugin-markdown - npm Package Compare versions

Comparing version 3.15.3 to 3.15.4

dist/resources/helpers/comments.js

@@ -29,12 +29,11 @@ "use strict";
 function default_1() {
-    Handlebars.registerHelper('comments', function (comment) {
+    Handlebars.registerHelper('comments', function (comment, showSummary = true, showTags = true) {
         var _a;
         const md = [];
-        if (comment.summary) {
+        if (showSummary && comment.summary) {
             md.push(Handlebars.helpers.comment(comment.summary));
         }
-        if ((_a = comment.blockTags) === null || _a === void 0 ? void 0 : _a.length) {
-            const tags = comment.blockTags
-                .filter((tag) => tag.tag !== '@returns')
-                .map((tag) => `**\`${(0, utils_1.camelToTitleCase)(tag.tag.substring(1))}\`**\n\n${Handlebars.helpers.comment(tag.content)}`);
+        const filteredTags = comment.blockTags.filter((tag) => tag.tag !== '@returns');
+        if (showTags && ((_a = comment.blockTags) === null || _a === void 0 ? void 0 : _a.length)) {
+            const tags = filteredTags.map((tag) => `**\`${(0, utils_1.camelToTitleCase)(tag.tag.substring(1))}\`**\n\n${Handlebars.helpers.comment(tag.content)}`);
             md.push(tags.join('\n\n'));
@@ -41,0 +40,0 @@ }

package.json

 {
   "name": "typedoc-plugin-markdown",
-  "version": "3.15.3",
+  "version": "3.15.4",
   "description": "A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -38,4 +38,2 @@ # typedoc-plugin-markdown
   Do not render in-page table of contents items. Defaults to `false`.
-- `--hideMembersSymbol<boolean>`<br>
-  Do not add special symbols for class members. Defaults to `false`.
 - `--publicPath<string>`<br>
@@ -42,0 +40,0 @@ Specify the base path for all urls. If undefined urls will be relative. Defaults to `.`.

No alert changes

Improved metrics

Total package byte prevSize

115196

0.13%

Worsened metrics

Lines of code

2482

-0.04%

Number of lines in readme file

48

-4%

No dependency changes