Skip to content

Commit 7b6229f

Browse files
feat: print references in class
1 parent bd45638 commit 7b6229f

File tree

3 files changed

+15
-6
lines changed

3 files changed

+15
-6
lines changed

src/lib/parser/markdown.ts

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import type {
77
MarkdownOptions
88
} from '../types';
99
import {jsDocsMetadata, jsDocsToParams} from './jdocs/mapper';
10-
import {emojiTitle, metadataToMarkdown, sourceCodeLink} from './render';
10+
import {emojiTitle, metadataToMarkdown} from './render';
1111
import type {Params, Row} from './types';
1212

1313
const toParams = (parameters?: DocEntry[]): Params[] =>
@@ -39,17 +39,21 @@ const classesToMarkdown = ({
3939
entry: DocEntry;
4040
} & Required<Pick<MarkdownOptions, 'headingLevel'>> &
4141
Omit<MarkdownOptions, 'headingLevel'>): string => {
42-
const {name, url, documentation, methods, properties, constructors} = entry;
42+
const {name, url, documentation, methods, properties, constructors, jsDocs} = entry;
4343

4444
const markdown: string[] = [`${headingLevel}${emojiTitle({emoji, key: 'classes'})} ${name}\n`];
4545

4646
if (documentation !== undefined && documentation !== '') {
4747
markdown.push(`${documentation}\n`);
4848
}
4949

50-
if (url !== undefined) {
51-
markdown.push(sourceCodeLink({emoji, url}));
52-
}
50+
const metadata = metadataToMarkdown({
51+
...jsDocsMetadata(jsDocs),
52+
url,
53+
emoji
54+
});
55+
56+
markdown.push(...metadata);
5357

5458
const publicConstructors: DocEntryConstructor[] = (constructors ?? []).filter(
5559
({visibility}) => visibility === 'public'

src/lib/parser/render.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export const emojiTitle = ({
1010
} & Pick<MarkdownOptions, 'emoji'>): string =>
1111
emoji === undefined || emoji === null ? '' : ` :${emoji[key]}:`;
1212

13-
export const sourceCodeLink = ({
13+
const sourceCodeLink = ({
1414
url,
1515
emoji
1616
}: Pick<MarkdownOptions, 'emoji'> & Required<Pick<DocEntry, 'url'>>): string =>

src/test/mock.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,11 @@ Description
288288

289289
Should differentiate methods / properties and static methods / properties
290290

291+
References:
292+
293+
* [https://github.com/peterpeterparker/tsdoc-markdown](https://github.com/peterpeterparker/tsdoc-markdown)
294+
295+
291296
[:link: Source](https://github.com/peterpeterparker/tsdoc-markdown/tree/main/src/test/mock.ts#L318)
292297

293298
### Static Methods

0 commit comments

Comments
 (0)