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.
v0.25.7
Bug Fixes
Fixed an issue where a namespace would not be created for merged function-namespaces only containing types, #2476.
Fixed an infinite loop when converting a union type which directly contained another union type which refers to itself, #2469.
v0.25.6
Bug Fixes
Fixed infinite loop caused by a fix for some complicated union/intersection types, #2468.
Improved infinite loop detection in type converter to reduce false positives.
v0.25.5
Features
Added a new hierarchy.html page to HTML output which displays the full inheritance hierarchy for classes included in the documentation, #182.
Added a --navigation.includeFolders (default: true) option to create nested navigation for projects which include many entry points, #2388.
Type parameters on functions/classes can will now link to the "Type Parameters" section, #2322.
Type parameters have also been changed to have a distinct color from type aliases when rendering, which can be changed with custom CSS.
TypeDoc now provides warnings if a signature comment is directly specified on a signature and contains @param tags which do not apply, #2368.
Extended reflection preview view for interfaces to include type parameters, #2455.
Added special cases for converting methods which are documented as returning this or accepting this as a parameter, #2458.
Note: This will only happen if a method is declared as method(): this, it will not happen if the method implicitly returns this
as the compiler strips that information when creating types for a class instance.
Improved handling of functions with properties. Previous TypeDoc versions would always create a separate
namespace for properties, now, TypeDoc will create a separate namespace if the function is declaration merged
with a namespace. If the properties are added via Object.assign or via property assignment on the function
TypeDoc will now instead add the properties to the function's page, #2461.
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.
v0.25.7 (2024-01-08)
Bug Fixes
Fixed an issue where a namespace would not be created for merged function-namespaces only containing types, #2476.
Fixed an infinite loop when converting a union type which directly contained another union type which refers to itself, #2469.
v0.25.6 (2024-01-01)
Bug Fixes
Fixed infinite loop caused by a fix for some complicated union/intersection types, #2468.
Improved infinite loop detection in type converter to reduce false positives.
v0.25.5 (2024-01-01)
Features
Added a new hierarchy.html page to HTML output which displays the full inheritance hierarchy for classes included in the documentation, #182.
Added a --navigation.includeFolders (default: true) option to create nested navigation for projects which include many entry points, #2388.
Type parameters on functions/classes can will now link to the "Type Parameters" section, #2322.
Type parameters have also been changed to have a distinct color from type aliases when rendering, which can be changed with custom CSS.
TypeDoc now provides warnings if a signature comment is directly specified on a signature and contains @param tags which do not apply, #2368.
Extended reflection preview view for interfaces to include type parameters, #2455.
Added special cases for converting methods which are documented as returning this or accepting this as a parameter, #2458.
Note: This will only happen if a method is declared as method(): this, it will not happen if the method implicitly returns this
as the compiler strips that information when creating types for a class instance.
Improved handling of functions with properties. Previous TypeDoc versions would always create a separate
namespace for properties, now, TypeDoc will create a separate namespace if the function is declaration merged
with a namespace. If the properties are added via Object.assign or via property assignment on the function
TypeDoc will now instead add the properties to the function's page, #2461.
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 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)
Bumps typedoc from 0.25.4 to 0.25.8.
Release notes
Sourced from typedoc's releases.
... (truncated)
Changelog
Sourced from typedoc's changelog.
... (truncated)
Commits
33db59c
Update changelog for release20b98db
Bump version to 0.25.82318949
Include all base classesece4f31
Fix circular depb6c5801
Fix duplicate programs on contextf5f31b0
ExposeContext.getNodeComment
, #2498d26f76f
Add support for@groupDescription
and@categoryDescription
285b537
Add a teste76d594
Fix crash when class implements itselfeb7510b
Correct custom theme docs, #2490Dependabot 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 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