Documentation generator for TypeScript projects.
gitRevision:short
placeholder option to --sourceLinkTemplate
option, #2529.
Links generated by TypeDoc will now default to using the non-short git revision.<footer>
tag, added footer.begin
and footer.end
render hooks for use by custom plugins, #2532.NoInfer
missing type parameter reference, #2539.@interface
, #2508.--excludeNotDocumented
was used and the project contained a reference to a removed signature, #2496.--maxTypeConversionDepth
option, #2507.--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.--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.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.