Module comment not rendering

[Timo Welde]

Hey, thanks for this module.

As described here: https://github.com/christopherthielen/typedoc-plugin-external-module-name#thing2quxts, it should be possible to add a module comment.
I tried putting the comment on top and below of @module and added @preferred, but no comment is rendering.

The command i am using is: typedoc --theme default --out docs
typedoc: v0.14.2
typedoc-plugin-external-module-name: v2.0.0

[Thierry Michel]

Hi here,

Finally, I made it work with the addition of an empty comment:

/**
 * This comment will be printed
 *
 * @module my/module
 * @preferred works too
 */

/***/

I've found that this line was returning no comment for the reflection (no idea why).
With 2 comments, reflection have the right comment and this code is executed.

[Wen Sun]

I met this problem as well, it seems that the problem still exists. And @thierrymichel's solution works for me.
This line still returns no comment. That's strange.
I also found that if there is any statement between two comment blocks, the @module annotation seems to fail. For example:

// foo/foo.ts
/**
 * @module foo
 */

/**
 * ...
 */
export interface Foo {}

will work, the module will be named 'foo'; but this will fail:

// foo/foo.ts
/**
 * @module foo
 */

import { bar } from 'bar';

/**
 * ...
 */
export interface Foo {}

the module will be named 'foo/foo'.

[Chris Thielen]

Try using the new @packageDocumentation tag from typedoc 0.15.8

/**
 * @packageDocumentation
 * @module foo
 */

[Chris Thielen]

also please upgrade to the new version https://github.com/christopherthielen/typedoc-plugin-external-module-name/releases/tag/2.2.1