typedoc-plugin-markdown
Advanced tools
Comparing version 4.0.2 to 4.0.3
@@ -235,3 +235,3 @@ import { MarkdownPageEvent } from '../app/events'; | ||
helpers: { | ||
getDeclarationComment: (model: import("typedoc").DeclarationReflection) => any; | ||
getDeclarationComment: (model: import("typedoc").DeclarationReflection) => import("typedoc").Comment | undefined; | ||
getDeclarationType: (model: import("typedoc").DeclarationReflection) => import("typedoc").SomeType | undefined; | ||
@@ -238,0 +238,0 @@ getFlattenedDeclarations: (model: import("typedoc").DeclarationReflection[], options?: { |
import { DeclarationReflection } from 'typedoc'; | ||
export declare function getDeclarationComment(model: DeclarationReflection): any; | ||
export declare function getDeclarationComment(model: DeclarationReflection): import("typedoc").Comment | undefined; |
@@ -8,7 +8,4 @@ "use strict"; | ||
} | ||
if (model.type?.declaration?.signatures?.length) { | ||
return model.type?.declaration.signatures[0].comment; | ||
} | ||
return model.comment; | ||
} | ||
exports.getDeclarationComment = getDeclarationComment; |
@@ -426,3 +426,3 @@ import { MarkdownThemeContext } from '../index.js'; | ||
export declare const helpers: (context: MarkdownThemeContext) => { | ||
getDeclarationComment: (model: DeclarationReflection) => any; | ||
getDeclarationComment: (model: DeclarationReflection) => Comment | undefined; | ||
getDeclarationType: (model: DeclarationReflection) => SomeType | undefined; | ||
@@ -429,0 +429,0 @@ getFlattenedDeclarations: (model: DeclarationReflection[], options?: { |
@@ -82,3 +82,6 @@ "use strict"; | ||
if (comment?.summary?.length) { | ||
row.push(context.partials.commentParts(comment.summary)?.split('\n')[0]); | ||
row.push(context.partials | ||
.commentParts(comment.summary) | ||
?.split('\n\n')[0] | ||
.replace(/\n/g, ' ')); | ||
} | ||
@@ -85,0 +88,0 @@ else { |
@@ -32,3 +32,3 @@ "use strict"; | ||
} | ||
name.push((0, markdown_1.backTicks)(`"${obj.name}"`)); | ||
name.push((0, markdown_1.backTicks)(obj.name)); | ||
const theType = this.helpers.getDeclarationType(obj); | ||
@@ -35,0 +35,0 @@ const typeString = obj.defaultValue && obj.defaultValue !== '...' |
{ | ||
"name": "typedoc-plugin-markdown", | ||
"version": "4.0.2", | ||
"version": "4.0.3", | ||
"description": "A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
310665