Releases: TypeStrong/typedoc
Releases · TypeStrong/typedoc
v0.23.15
Features
- TypeDoc will now treat
@typedef {import("foo").Bar<Z>} Baztype declarations which forward type parameters to the imported
symbol as re-exports of that symbol, #2044.
Bug Fixes
- TypeDoc will now prefer comments on variable declarations over signature comments, #2042.
- Fixed double rendering of "Type Parameters" header, #2054.
- Fixed double rendering of "Hierarchy" header, #2053.
- Removed unused
widgets.pngand[email protected]files from generated assets folder.
v0.23.14
Features
- Added support for defining one-off external link mappings with
externalSymbolLinkMappingssee
the documentation for usage examples and caveats, #2030. - External link resolvers defined with
addUnknownSymbolResolverwill now be checked when resolving@linktags, #2030.
Note: To support this, resolution will now happen during conversion, and as such,Renderer.addUnknownSymbolResolverhas been
soft deprecated in favor ofConverter.addUnknownSymbolResolver. Plugins should update to use the method onConverter.
DefaultThemeRenderContext.attemptExternalResolutionhas also been deprecated since it will repeat work done during conversion,
useReferenceType.externalUrlinstead. - Added
Converter.addUnknownSymbolResolverfor use by plugins supporting external links.
Bug Fixes
v0.23.13
v0.23.12
Features
- Added a new
ParameterType.Objectfor declaring object options which will be shallowly merged when read from user configuration. - Added a new
Application.EVENT_BOOTSTRAP_ENDevent emitted whenApplication.bootstrapis called.
Bug Fixes
- TypeDoc will now work properly in packages mode when converting packages outside the current working directory, #2043.
- Fixed deprecation warning for
isIdentifierOrPrivateIdentifier. - Fixed centering of title bar on wide displays, #2046.
Thanks!
v0.23.11
Features
- Added support for TypeScript 4.8.
- Introduced a
skipErrorCheckingoption which instructs TypeDoc to not ask TypeScript for compiler errors
before attempting to generate documentation. Turning this on may improve generation speed, but could also
cause a crash if your code contains compiler errors. - Added support for JS entry points when using packages mode, #2037.
Bug Fixes
- Fixed crash when converting abstract mixin class, #2011.
- Readme files within monorepos now have
@linktags resolved, #2029. - Correctly resolve unqualified links to class members within parameters, #2031.
- TypeDoc will now consider other reflections with the same name as parents when resolving links, #2033.
- The "Hierarchy" and "Type Parameters" helpers on
DefaultThemeRenderContextnow contain all the HTML for their sections of the page, #2038.
Thanks!
v0.23.10
Features
- Added support for detecting comments directly before parameters as the parameter comment, #2019.
- Added support for using the comment directly before a constructor parameter that declares a property as the property comment, #2019.
- Improved schema generation to give better autocomplete for the
sortoption. - Optional properties are now visually distinguished in the index/sidebar by rendering
propasprop?, #2023. DefaultThemeRenderContext.markdownnow also accepts aCommentDisplayPart[]for rendering, #2004.- Expose
Converter.resolveLinksmethod for use withConverter.parseRawComment, #2004.
Bug Fixes
- Fixed schema URL for TSDoc preventing the use of
typedoc/tsdoc.jsonin TSDoc extends, #2015. - Improved detection of package names in repositories using pnpm, #2017.
- Fixed missing JSDoc style
@typedefcomments for properties, #2020.
Thanks!
v0.23.9
Bug Fixes
- TypeDoc will no longer skip entry points which have no exports, #2007.
If using"entryPointStrategy": "expand", this change may result in new pages being added to your documentation.
If this is not desired, you can use theexcludeoption to filter them out. - Fixed missing comments on callable variable-functions constructed indirectly, #2008.
- Packages mode will now respect the
--includeVersionflag, #2010. - Fixed multiple reflections mapping to the same file name on case insensitive file systems, #2012.
v0.23.8
Features
- Added defined in links for classes, enums, #180.
- Added support for
*.ghe.comand*.github.usGitHub enterprise domains for source links, #2001. - Expose
Converter.parseRawCommentfor plugins to parse additional markdown files, #2004.
Bug Fixes
- TypeDoc will no longer emit a warning for
{@link}containing a URL, #1980. excludeNotDocumentedwill no longer remove functions/methods/accessors which are documented, #1994.- Fixed missing
sourcesproperty on signature reflections #1996.
Thanks!
v0.23.7
Bug Fixes
- Tags must now contain whitespace after the tag name to be parsed as a tag,
@jest/globalsin a comment will no longer be parsed as a tag #1990. - The private member visibility option will now be respected in generated sites, #1992.
- Overload rendering will no longer be broken if JavaScript is disabled, #453.
- All overloads are now shown at once rather than requiring clicks to see the documentation for each signature, #1100.
v0.23.6
Features
- Improved support for
--entryPointStrategy Packages. TypeDoc will now load package-specific configurations frompackage.jsontypedocfield. This configuration allows configuring a custom display name (typedoc.displayName) field, entry point (typedoc.entryPoint- this is equivalent and will overridetypedocMain), and path to a readme file to be rendered at the top of the package page (typedoc.readmeFile), #1658. - The
--includeVersionoption will now be respected by--entryPointStrategy Packages. Also, for this combination, missingversionfield in the rootpackage.jsonwill not issue a warning. - The
navigationpartial will now call the newsettings,primaryNavigation, andsecondaryNavigationpartials, #1987.
Bug Fixes
- All warnings will be reported instead of only the first warning of a given type, #1981.
- Include references will no longer be incorrectly parsed as links, #1986.
- The generated schema.json on the website will now use enum values rather than enum names if possible.