Skip to content

Reproduce @linkcode bug introduced with TypeDoc v0.28.0 #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "typedoc-repros",
"dependencies": {
"typedoc": "latest",
"typescript": "latest"
"typedoc": "0.28.2",
"typescript": "5.8.3"
}
}
24 changes: 22 additions & 2 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,24 @@
/**
* Some code reproducing a bug.
* This is some class.
*/
export const bug = 123;
export class SomeClass {

/**
* Creates an instance of {@linkcode SomeClass}.
*
* “SomeClass” in the description above has a `@linkcode` tag and
* should:
* 1. Link to `SomeClass` (like in the “Returns” section below).
* 2. Be rendered as inline code.
*
* [See](https://typedoc.org/documents/Tags.__link_.html#jsdoc-compatibility):
* > TypeDoc will also recognize the `@linkplain` and `@linkcode`
* > JSDoc tags and resolve them with the same method as other
* > links.
*
* This is working with TypeDoc v0.27.9, but fails to produce the
* same expected output starting with v0.28.0.
*/
constructor() { }

}
Loading