typedoc-plugin-merge-modules
typedoc-plugin-merge-modules copied to clipboard
Category description is missing in the generated documentation
Hi there, thanks for the great plugin.
Is there any way to merge the module-level comments when using mergeModulesMergeMode: "module"
?
I have several files which I want merged as one module and each one provides a @categoryDescription
for its relevant categories. In the output I can only see the category description of the first file that's in that module.
I've tried using:
Method 1:
catA.js
:
/**
* @module SomeModule
*
* @categoryDescription CategoryA
* ...
*/
catB.js
:
/**
* @module SomeModule
*
* @categoryDescription CategoryB
* ...
*/
Method 2:
catA.js
:
/**
* @module SomeModule
*/
/**
* @packageDocumentation
* @categoryDescription CategoryA
* ...
*/
catB.js
:
/**
* @module SomeModule
*/
/**
* @packageDocumentation
* @categoryDescription CategoryB
* ...
*/
I've also tried adding the @mergeTarget
tag to each comment, right under @module
but if I understand correctly this is meant to select only one module comment, rather than merging them all? But in case case I get an error "Encountered an unknown block tag @mergeTarget"...
Is there a way to have all category descriptions show on the module summary page while still having the descriptions in separate files?