typedoc
typedoc copied to clipboard
Documentation generator for TypeScript projects.
On older versions, I used to have the following in my typedoc.json: ``` "validation": true, ``` This would also report `notDocumented` warnings. After updating to 0.28.x, this is no longer...
Apparently including regions from TSX like `{@includeCode ./examples.tsx#component}` was not supported: ``` [error] @includeCode tag in MyComponent specified "./examples.tsx#component", but regions are not supported for this file extension. ```
## Search terms multiple repository link ## Expected Behavior TypeDoc links to objects in dependency repository. ## Actual Behavior Showing error messages with failed resolution. ## Steps to reproduce the...
## Current Behavior When `sort: ["source-order"]` is configured in `typedoc.json`, it only affects the ordering of items **within** groups, not the groups themselves. Groups are always ordered alphabetically. **Example configuration:**...
## Search terms declare const, @enum tag, enum, docs.json, declaration files ## Expected Behavior `declare const` objects annotated with `@enum` tags should be documented as enumerations and included in the...
## Search terms exclude option test describe expect ## Expected Behavior Typedoc ignores tests files ## Actual Behavior Typedoc throws errors related to test files that should be ignore ##...
### Search Terms group heading id, group anchor, categorizeByGroup linking, group permalink, @group tag linking ### Expected Behavior When using `@group` tags in JSDoc comments with `categorizeByGroup: true` in TypeDoc...
## Search terms Symbol property, computed property name, string ## Expected Behavior Render computed properties in some way that looks like TypeScript syntax. ## Actual Behavior Renders computed properties as...