Changelog
v0.23.3 (2022-07-01)
@example
tag, #1967.intentionallyNotExported
will now properly respect qualified names, #1972.export * as NS
declarations, #1973.export const x = () => 123
function variables, #1973.get
and set
signatures of an accessor have a comment.--htmlLang
option to set the lang
attribute in the generated HTML. Defaults to en
, #1951.--basePath
option to override TypeDoc's detected root directory, #1924.:getter
and :setter
meaning keywords in declaration references.Changelog
v0.23.2 (2022-06-28)
@module
comments in the entry point, #1963.<= 0
due to searchCategoryBoosts
or searchGroupBoosts
will be excluded from search.Changelog
v0.23.1 (2022-06-26)
Changelog
v0.23.0 (2022-06-26)
{@link}
tags in comments will now be resolved as declaration references similar to TSDoc's declaration references.
For most cases, this will just work. See the documentation for details on how link resolution works.[[ target ]]
). Use {@link target}
instead. The {@link}
syntax will be recognized by TypeScript 4.3 and later and used to provide better intellisense. TypeDoc version 0.24.0 will remove support for [[ target ]]
style links.
Support for [[`links`]]
with brackets + code ticks have been dropped.extends
in typedoc.json is now resolved using NodeJS module resolution, so a local path must begin with ./
.DeclarationReflection
s, getSignature
is no longer a one-tuple.DeclarationReflection
s, setSignature
is no longer a one-tuple.DeclarationReflection
s, typeParameter
has been renamed to typeParameters
searchGroupBoosts
option must now be given the rendered group name rather than reflection kind names, and can be given custom group names.@inheritDoc
now follows the behavior specified by TSDoc when copying comments with a reference.gaSite
option has been removed since Google Analytics now infers the site automatically, updated Google Analytics script to latest version, #1846.hideLegend
option has been removed as the default theme no longer contains a legend.listInvalidSymbolLinks
option has been removed. Use validation.invalidLink
instead.true
and false
values have been removed from --emit
, to migrate replace true
with "both"
and false
with "docs"
(the default).validation.invalidLink
option is now on by default.reflection.decorates
, reflection.decorators
, and their corresponding interfaces have been removed as no code in TypeDoc used them.Comment
class has changed significantly to support multiple tag kinds.Converter.EVENT_CREATE_TYPE_PARAMETER
and Converter.EVENT_CREATE_DECLARATION
will now never be passed a ts.Node
as their third argument.ReflectionFlag.Const
flag set.reflection.defaultValue
is no longer set for enum members. The same information is available on reflection.type
with more precision.removeReaderByName
, addDeclarations
and removeDeclarationByName
methods on Options
.ProjectReflection.directory
, it was unused by TypeDoc and not properly tested.ProjectReflection.files
, this was an internal cache that should not have been exposed, and shouldn't have existed in the first place, since removing it made TypeDoc faster.ReflectionGroup.kind
since groups can now be created with the @group
tag.ReflectionKind.Event
, the @event
tag is now an alias for @group Events
. Note: This changes the value of ReflectionKind.Reference
from 16777216
to 8388608
.TypeDoc now supports the @group
tag to group reflections in a page. If no @group
tag is specified, reflections will be grouped according to their kind, #1652.
TypeDoc will now search for typedoc.js(on)
in the .config
folder in the current working directory.
Entry point strategies Resolve
and Expand
may now specify globs, #1926.
typedoc.json
now supports comments like tsconfig.json
.
TypeDoc will now read the blockTags
, inlineTags
, and modifierTags
out of tsdoc.json
in the same directory as tsconfig.json
if it exists.
It is recommended to add "extends": ["typedoc/tsdoc.json"]
, which defines TypeDoc specific tags to your tsdoc.json
if you create one.
If an exported symbol has multiple declarations, TypeDoc will now check all appropriate declarations for comments, and warn if more than one declaration contains a comment, #1855.
Improved support for JSDoc style @example
tags. If the tag content does not include a code block, TypeDoc now follows VSCode's behavior of treating the entire block as a code block, #135.
TypeDoc will now render members marked with @deprecated
with a line through their name, #1381.
Added new commentStyle
option which can be used to control what comments TypeDoc will parse.
| Value | Behavior |
| ----- | -------------------------------------- |
| JSDoc | Use block comments starting with /**
|
| Block | Use all block comments |
| Line | Use //
comments |
| All | Use both block and line comments |
TypeDoc will now warn if part of a comment will be overwritten due to use of @inheritDoc
instead of silently dropping part of the comment.
Added support for inline @inheritDoc
tags, #1480.
It is now possible to link directly to a specific overload, #1326.
The JSON output will now include URLs to the file on the remote repository if possible.
Added a new visibilityFilters
option which controls the available filters on a page.
TypeDoc will now try to place block elements on a new line in HTML output, resulting in less overwhelming diffs when rebuilding docs, #1923.
Added blockTags
, inlineTags
, modifierTags
to control which tags TypeDoc will allow when parsing comments.
If a tag not in in one of these options is encountered, TypeDoc will produce a warning and use context clues to determine how to parse the tag.
Type Parameters
heading if there are no type parameters in some cases.implements
by other interfaces/classes.@inheritDoc
on accessors, #1927.exports.foo = ...
will now be converted as variables rather than properties.searchCategoryBoosts
are now correctly computed for all categories, #1960.excludeNotDocumented
option will no longer hide a module if it has a documentation comment, #1948.--excludeNotDocumented
from hiding properties of type literals (a
in function fn(p: { a: string })
), #1752.cts
and mts
extensions in packages resolution mode, #1952.Changelog
v0.22.18 (2022-06-25)
@enum
style enums to also permit non-literal strings and numbers, #1956.searchGroupBoosts
was only computing the boost for the first reflection in a group, #1958.