Commit f43c01d
authored
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4&size=40){kind=avatar}
chore: bump typedoc from 0.28.13 to 0.28.17 (#397)
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.28.13 to
0.28.17.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/TypeStrong/TypeDoc/releases">typedoc's
releases</a>.</em></p>
<blockquote>
<h2>v0.28.17</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Improved handling of comments for type aliases which have been
declaration merged with functions, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3064">#3064</a>.</li>
<li>Fixed anchor link generation to members named <code>$</code>, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3065">#3065</a>.</li>
<li>Corrected typing of the <code>plugin</code> option to permit
functions, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3066">#3066</a>.</li>
<li>Warnings about unused <code>@param</code> tags will now be properly
suppressed when they come from declaration files and
the suppressCommentWarningsInDeclarationFiles option is enabled, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3070">#3070</a>.</li>
<li>Fixed conversion of types referencing type parameters on functions,
<a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3071">#3071</a>.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a href="https://github.com/pjeby"><code>@pjeby</code></a></li>
</ul>
<h2>v0.28.16</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Fixed an issue causing TypeDoc to fail to generate documentation
when implementing interfaces, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3052">#3052</a>.</li>
<li>Fixed an issue preventing automatic entry point discovery on
Windows, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3057">#3057</a>.</li>
<li>Improved vertical positioning of text icons, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3056">#3056</a>.</li>
<li>TypeDoc no longer includes source location information for type
literal reflections. This could sometimes
cause TypeDoc to infer the wrong path when resolving base paths for
display.</li>
<li>Adjusted markdown rendering to allow <code>markdownItLoader</code>
to override more rendering <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3055">#3055</a>.</li>
</ul>
<h3>Features</h3>
<ul>
<li>Added support for regions for <code>@include</code> in
<code>.tsx</code>, <code>.cjs</code>, and <code>.mjs</code> file
references <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3048">#3048</a>.</li>
<li>Comments for TS-in-JS <code>@typedef</code> tags may now specify
modifier tags with the inline tag syntax <code>{@mod}</code>.
This makes it possible to add modifier tags to these members, which
previously was not possible as
TypeScript's parsing stops for these members at the next non-braced tag,
<a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2916">#2916</a>
and <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3050">#3050</a>.</li>
<li>A <code>typedoc-config.schema.json</code> is now included in the
root of the package with a JSON schema for TypeDoc's
configuration file. The schema for the latest version is also published
at <a
href="https://typedoc.org/schema.json">https://typedoc.org/schema.json</a>
and will automatically be picked up when writing typedoc.json files if
you are using VSCode, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3054">#3054</a>.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a href="https://github.com/a10nik"><code>@a10nik</code></a></li>
<li><a href="https://github.com/kozi"><code>@kozi</code></a></li>
<li><a href="https://github.com/Lakuna"><code>@Lakuna</code></a></li>
</ul>
<h2>v0.28.15</h2>
<h3>Features</h3>
<ul>
<li>The <code>gitRevision</code> option now accepts the special value
<code>{branch}</code>, which indicates source links should use
the current git branch for links, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3041">#3041</a>.</li>
<li>Introduced <code>validation.invalidPath</code> for suppressing
warnings caused by referencing relative paths which
do not exist when building the documentation, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3033">#3033</a>.</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md">typedoc's
changelog</a>.</em></p>
<blockquote>
<h2>v0.28.17 (2026-02-13)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Improved handling of comments for type aliases which have been
declaration merged with functions, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3064">#3064</a>.</li>
<li>Fixed anchor link generation to members named <code>$</code>, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3065">#3065</a>.</li>
<li>Corrected typing of the <code>plugin</code> option to permit
functions, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3066">#3066</a>.</li>
<li>Warnings about unused <code>@param</code> tags will now be properly
suppressed when they come from declaration files and
the suppressCommentWarningsInDeclarationFiles option is enabled, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3070">#3070</a>.</li>
<li>Fixed conversion of types referencing type parameters on functions,
<a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3071">#3071</a>.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a href="https://github.com/pjeby"><code>@pjeby</code></a></li>
</ul>
<h2>v0.28.16 (2026-01-12)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Fixed an issue causing TypeDoc to fail to generate documentation
when implementing interfaces, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3052">#3052</a>.</li>
<li>Fixed an issue preventing automatic entry point discovery on
Windows, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3057">#3057</a>.</li>
<li>Improved vertical positioning of text icons, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3056">#3056</a>.</li>
<li>TypeDoc no longer includes source location information for type
literal reflections. This could sometimes
cause TypeDoc to infer the wrong path when resolving base paths for
display.</li>
<li>Adjusted markdown rendering to allow <code>markdownItLoader</code>
to override more rendering <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3055">#3055</a>.</li>
</ul>
<h3>Features</h3>
<ul>
<li>Added support for regions for <code>@include</code> in
<code>.tsx</code>, <code>.cjs</code>, and <code>.mjs</code> file
references <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3048">#3048</a>.</li>
<li>Comments for TS-in-JS <code>@typedef</code> tags may now specify
modifier tags with the inline tag syntax <code>{@mod}</code>.
This makes it possible to add modifier tags to these members, which
previously was not possible as
TypeScript's parsing stops for these members at the next non-braced tag,
<a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2916">#2916</a>
and <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3050">#3050</a>.</li>
<li>A <code>typedoc-config.schema.json</code> is now included in the
root of the package with a JSON schema for TypeDoc's
configuration file. The schema for the latest version is also published
at <a
href="https://typedoc.org/schema.json">https://typedoc.org/schema.json</a>
and will automatically be picked up when writing typedoc.json files if
you are using VSCode, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3054">#3054</a>.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a href="https://github.com/a10nik"><code>@a10nik</code></a></li>
<li><a href="https://github.com/kozi"><code>@kozi</code></a></li>
<li><a href="https://github.com/Lakuna"><code>@Lakuna</code></a></li>
</ul>
<h2>v0.28.15 (2025-11-29)</h2>
<h3>Features</h3>
<ul>
<li>The <code>gitRevision</code> option now accepts the special value
<code>{branch}</code>, which indicates source links should use
the current git branch for links, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3041">#3041</a>.</li>
<li>Introduced <code>validation.invalidPath</code> for suppressing
warnings caused by referencing relative paths which
do not exist when building the documentation, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3033">#3033</a>.</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/882cfb95ad97af81d98d10b4850967819d898477"><code>882cfb9</code></a>
Update changelog for release</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/89dda48e93879da0e4ddaf13d7a2a43c922389a7"><code>89dda48</code></a>
Bump version to 0.28.17</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/5ac59d8989f9c5cef69f3acc7f221e630dbc64c2"><code>5ac59d8</code></a>
Slightly improve docs for plugin creation</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/6f5938947bc30580141fd4087da882dc929ff465"><code>6f59389</code></a>
Update example dependencies</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/977c604e78577f1aea8bd44ee4fb9b436737487f"><code>977c604</code></a>
Fix <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3070">#3070</a></li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/6aba264042da6ac3e70b497a9d7871b3fdb7ec88"><code>6aba264</code></a>
Fix OIDC published plugins author links on site</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/9574e72d178596de0bd526764000e2d80d049a57"><code>9574e72</code></a>
Fix substitution types</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/2e1967b0a16b05818d06e9771ec99ac8786ffb10"><code>2e1967b</code></a>
Even more docs</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/56274747a6a140e4878f700c8cca3033275617da"><code>5627474</code></a>
Fix formatting</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/f97ec69527ba66a11f5c7012bdb76dfa064b9d54"><code>f97ec69</code></a>
Improve docs for declaration references</li>
<li>Additional commits viewable in <a
href="https://github.com/TypeStrong/TypeDoc/compare/v0.28.13...v0.28.17">compare
view</a></li>
</ul>
</details>
<details>
<summary>Maintainer changes</summary>
<p>This version was pushed to npm by [GitHub Actions](<a
href="https://www.npmjs.com/~GitHub">https://www.npmjs.com/~GitHub</a>
Actions), a new releaser for typedoc since your current version.</p>
</details>
<br />
[](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
<details>
<summary>Dependabot commands and options</summary>
<br />
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)
</details>
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>1 parent a743bdd commit f43c01d
2 files changed
+28
-28
lines changedSome generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
100 | 100 | | |
101 | 101 | | |
102 | 102 | | |
103 | | - | |
| 103 | + | |
104 | 104 | | |
105 | 105 | | |
106 | 106 | | |
| |||
0 commit comments