@packageDocumentation not behaving correctly

[lageorgem]

Hello,

I was hoping I am able to specify a module-level documentation block by specifiying the @packageDocumentation annotation as per these docs. I am currently using your package as a replacement for this obsolete package which provided such a feature. See here.

Would it be too much work to include this functionality?

[krisztianb]

Hi. What exactly is missing? Are you looking for the @preferred tag to be implemented or are @packageDocumentation tags ignored when merging the modules?

Could you post the version of TypeDoc and this plugin that you are using and also your TypeDoc config?

[lageorgem]

Hello. The following is my config, passed as arguments to the command:

typedoc --tsconfig ./tsconfig.json --mergeModulesMergeMode module --readme ./README.md --out docs/ src/

my versions:

"typedoc": "^0.21.9",
"typedoc-plugin-merge-modules": "^3.0.2",

I think I am looking for both. Currently I have a doc comment that looks like this

/ *
 * Comment content
 * @packageDocumentation
 * @module Transformation
 * @preferred
 */

This comment does not appear on the index for the Transformation module. In fact, it does not appear anywhere. I was hoping to be able to add a documentation page for the home page of a module in order to explain how it works properly.

[krisztianb]

I'm not familiar with these module comments but I will take a look and report back to you.

PS: You need to start the comment with /** right?

[krisztianb]

I released 3.1.0 which adds the functionality you are looking for. Instead of @preferred you need to use @mergeTarget. You only need to use this new tag if more than one of the modules that are merged have a comment.

Please see if it works as expected and report back so we can close this issue. Thanks.

[lageorgem]

It works wonderful. Thank you very much for the incredibly quick response and fix.

[krisztianb]

Glad to hear. Please report back if you find any issues.