From f6aca3751255e353c57a430171e5be8c594ae264 Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Mon, 12 Feb 2024 01:02:03 +0000
Subject: [PATCH] chore(deps): Bump typedoc from 0.25.7 to 0.25.8 (#259)
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.25.7 to 0.25.8.
Release notes
Sourced from typedoc's releases.
v0.25.8
Features
- Added a new
--sitemapBaseUrl option. When specified, TypeDoc will generate a sitemap.xml in your output folder that describes the site, #2480.
- Added support for the
@class tag. When added to a comment on a variable or function, TypeDoc will convert the member as a class, #2479.
Note: This should only be used on symbols which actually represent a class, but are not declared as a class for some reason.
- Added support for
@groupDescription and @categoryDescription to provide a description of groups and categories, #2494.
- API: Exposed
Context.getNodeComment for plugin use, #2498.
Bug Fixes
- Fixed an issue where a namespace would not be created for merged function-namespaces which are declared as variables, #2478.
- A class which implements itself will no longer cause a crash when rendering HTML, #2495.
- Variable functions which have construct signatures will no longer be converted as functions, ignoring the construct signatures.
- The class hierarchy page will now include classes whose base class is not included in the documentation, #2486.
- Fixed an issue where, if the index section was collapsed when loading the page, all content within it would be hidden until expanded, and a member visibility checkbox was changed.
- API:
Context.programs will no longer contain duplicates, #2498.
Changelog
Sourced from typedoc's changelog.
v0.25.8 (2024-02-09)
Features
- Added a new
--sitemapBaseUrl option. When specified, TypeDoc will generate a sitemap.xml in your output folder that describes the site, #2480.
- Added support for the
@class tag. When added to a comment on a variable or function, TypeDoc will convert the member as a class, #2479.
Note: This should only be used on symbols which actually represent a class, but are not declared as a class for some reason.
- Added support for
@groupDescription and @categoryDescription to provide a description of groups and categories, #2494.
- API: Exposed
Context.getNodeComment for plugin use, #2498.
Bug Fixes
- Fixed an issue where a namespace would not be created for merged function-namespaces which are declared as variables, #2478.
- A class which implements itself will no longer cause a crash when rendering HTML, #2495.
- Variable functions which have construct signatures will no longer be converted as functions, ignoring the construct signatures.
- The class hierarchy page will now include classes whose base class is not included in the documentation, #2486.
- Fixed an issue where, if the index section was collapsed when loading the page, all content within it would be hidden until expanded, and a member visibility checkbox was changed.
- API:
Context.programs will no longer contain duplicates, #2498.
Commits
[](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)
---
Dependabot commands and options
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 merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show 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)
---
package-lock.json | 14 +++++++-------
package.json | 2 +-
2 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/package-lock.json b/package-lock.json
index 276b3d3..0e94fc1 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -22,7 +22,7 @@
"ts-jest": "^29.1.2",
"ts-node": "^10.9.2",
"tslint": "^6.1.3",
- "typedoc": "^0.25.7",
+ "typedoc": "^0.25.8",
"typescript": "^5.0.4"
},
"engines": {
@@ -6707,9 +6707,9 @@
}
},
"node_modules/typedoc": {
- "version": "0.25.7",
- "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.7.tgz",
- "integrity": "sha512-m6A6JjQRg39p2ZVRIN3NKXgrN8vzlHhOS+r9ymUYtcUP/TIQPvWSq7YgE5ZjASfv5Vd5BW5xrir6Gm2XNNcOow==",
+ "version": "0.25.8",
+ "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.8.tgz",
+ "integrity": "sha512-mh8oLW66nwmeB9uTa0Bdcjfis+48bAjSH3uqdzSuSawfduROQLlXw//WSNZLYDdhmMVB7YcYZicq6e8T0d271A==",
"dev": true,
"dependencies": {
"lunr": "^2.3.9",
@@ -11929,9 +11929,9 @@
"dev": true
},
"typedoc": {
- "version": "0.25.7",
- "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.7.tgz",
- "integrity": "sha512-m6A6JjQRg39p2ZVRIN3NKXgrN8vzlHhOS+r9ymUYtcUP/TIQPvWSq7YgE5ZjASfv5Vd5BW5xrir6Gm2XNNcOow==",
+ "version": "0.25.8",
+ "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.8.tgz",
+ "integrity": "sha512-mh8oLW66nwmeB9uTa0Bdcjfis+48bAjSH3uqdzSuSawfduROQLlXw//WSNZLYDdhmMVB7YcYZicq6e8T0d271A==",
"dev": true,
"requires": {
"lunr": "^2.3.9",
diff --git a/package.json b/package.json
index c9c0f16..c03e797 100644
--- a/package.json
+++ b/package.json
@@ -53,7 +53,7 @@
"ts-jest": "^29.1.2",
"ts-node": "^10.9.2",
"tslint": "^6.1.3",
- "typedoc": "^0.25.7",
+ "typedoc": "^0.25.8",
"typescript": "^5.0.4"
},
"peerDependencies": {