Sourced from typedoc's releases.
v0.25.8
Features
- Added a new
--sitemapBaseUrl
option. When specified, TypeDoc will generate asitemap.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.
Sourced from typedoc's changelog.
v0.25.8 (2024-02-09)
Features
- Added a new
--sitemapBaseUrl
option. When specified, TypeDoc will generate asitemap.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.
33db59c
Update changelog for release20b98db
Bump version to 0.25.82318949
Include all base classesece4f31
Fix circular depb6c5801
Fix duplicate programs on contextf5f31b0
Expose Context.getNodeComment
, #2498d26f76f
Add support for @groupDescription
and @categoryDescription
285b537
Add a teste76d594
Fix crash when class implements itselfeb7510b
Correct custom theme docs, #2490