Changelog
v0.25.10 (2024-03-03)
@interface
, #2508.Changelog
v0.25.9 (2024-02-26)
--excludeNotDocumented
was used and the project contained a reference to a removed signature, #2496.--maxTypeConversionDepth
option, #2507.Changelog
v0.25.8 (2024-02-09)
--sitemapBaseUrl
option. When specified, TypeDoc will generate a sitemap.xml
in your output folder that describes the site, #2480.@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.@groupDescription
and @categoryDescription
to provide a description of groups and categories, #2494.Context.getNodeComment
for plugin use, #2498.Context.programs
will no longer contain duplicates, #2498.Changelog
v0.25.7 (2024-01-08)
Changelog
v0.25.6 (2024-01-01)
Changelog
v0.25.5 (2024-01-01)
--navigation.includeFolders
(default: true
) option to create nested navigation for projects which include many entry points, #2388.@param
tags which do not apply, #2368.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.Object.assign
or via property assignment on the function
TypeDoc will now instead add the properties to the function's page, #2461.notDocumented
validation will no longer require documentation for data within parameters that cannot be documented via @param
, #2291.typedocOptions
fields from extended tsconfig files, #2334.@group
and @category
organization is now applied later to allow inherited comments to create groups/categories, #2459.this
, #2466.M
icon rather than sharing with the namespace icon.
Note: The default CSS still colors both modules and namespaces the same, as it is generally uncommon to have both in a generated site.Changelog
v0.25.4 (2023-11-26)
DefaultThemeRenderContext.reflectionPreview
helper.gitRevision
will now be replaced in sourceLinkTemplate
, #2434.Object.assign
, #2436.skipLibCheck
is used to ignore some compiler errors, #2438.@example
tag titles will now be rendered in the example heading, #2440.@namespace
-created namespaces, #2444.Changelog
v0.25.3 (2023-10-29)
--sourceLinkExternal
option to render source code links as external, #2415.declarationMap
option to be set to true to handle cross-package links in packages mode, #2416.external-last
option for the --sort
option, #2418.Changelog
v0.25.2 (2023-10-08)
navigationLeaves
option to remove branches from the navigation tree, #2382.sortEntryPoints
option (defaults to true) to allow disabling entry point sorting, #2393.@template
constraints on JSDoc defined type parameters, #2389.declare module "foo"
, #2401.Changelog
v0.25.1 (2023-09-04)
stripYamlFrontmatter
config option to remove YAML frontmatter from README.md, #2381.--excludeCategories
config option to remove reflections present in any excluded category, #1407.DefaultTheme.buildNavigation
to customize the displayed navigation tree, #2287.
Note: This change renders navigation.fullTree
obsolete. If you set it, TypeDoc will warn that it is being ignored.
It will be removed in v0.26.DefaultThemeRenderContext.icons
is overwritten by a custom theme.
Note: To perform this optimization, TypeDoc relies on DefaultThemeRenderContext.iconCache
being rendered within
each page. TypeDoc does it in the defaultLayout
template.@property
now works as expected if used to override a method's documentation.--watch
mode works again, #2378.intrinsic
keyword if TS intrinsic types are included in documentation.--exclude
is now respected when expanding globs in entry points, #2376.