If a file starts with a @license comment block, typedoc doesn't generate the module documentation

[xuhdev]

Search terms

@license, @module

Expected Behavior

Given a file a.ts with the following content:

/**@license MIT
 *
 * Full permission notice.
 */

/**
 * This is an awesome module.
 * @module good-module
 */

export function goodFunction() {
}

typedoc a.ts generates an output that the module doc is completely missing.

Actual Behavior

typedoc should generate the module doc.

Steps to reproduce the bug

1. Save the file above as a.ts.
2. Install the latest typedoc and run typedoc a.ts.

Environment

• Typedoc version: 0.25.13
• TypeScript version: 5.4.5
• Node.js version: 20.12.2
• OS: Debian

Additional Context

JSDoc supports the @license tag to indicate the license of the file. If the file above is fed to JSDoc, it will generate the module documentation properly.

I also wrote a blog post on @license, which may help clarify some background.