Comments (1)
Adding @group
to the child is the correct way to add children to the group. In this case, it sounds like you're adding @group
to module exports, so you'd need to put the @groupDescription
tag on the module itself, for example:
/**
* @module
* @groupDescription X
* X desc
*/
/**
* @group X
*/
export function x() {}
Which module file to add this comment to depends on your setup. If you are re-exporting everything from a single file with export * from ...
, then it needs to go in that file, not in the file where the x
function is declared.
If you are re-exporting with export * as XFuncs from ...
, then you can place the comment in the x.js
file, or on the re-export like this:
/**
* @groupDescription X
* X desc
*/
export * as XFuncs from "./x.js"
from typedoc.
Related Issues (20)
- Maximum call stack size exceeded for complex type HOT 3
- `@interface` type references do not always link correctly. HOT 1
- Duplicate comment in interfaces and types HOT 3
- How to exclude a folder to not be parsed? HOT 1
- How to include one dependency while using --excludeExternals? HOT 2
- [BUG] Index is empty initially HOT 3
- [BUG] Weird behavior with h2 headers when no h1 is present
- How to include changelog.md in typedoc output? HOT 9
- Typescript 5.4 support HOT 2
- Segoe UI font issue on Mac shows random letter/numbers in many places HOT 8
- `const` interpreted as function typed via an `interface` declaration, yield unexpected comment summaries HOT 5
- Add `packageOptions` config value for packages mode
- Cannot link to `default` property HOT 1
- `entryPoints` custom names HOT 1
- How to apply `@inheritDoc` tag to all classes without inheriting the `@deprecated` tag from parents HOT 3
- feat: render readthedocs flyout menu for default theme HOT 3
- Are there runtime traversal utils available for browser usage? HOT 6
- Support using full hexsha as default gitRevision value HOT 1
- Option `sitemapBaseUrl` is not documented HOT 1
- How to reference a method with a symbol name? HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from typedoc.