Variables in separate export statement get doc of export statement, not doc of declaration

[Josh-Cena]

Search terms

export variable

Steps to reproduce the bug

// constants.d.ts

/** A constant */
declare const constant1 = 1;
/** Another constant */
declare const constant2 = true;
/**
 * bar
 * @param a foo
 */
declare function foo(a: number): void;

/**
 * copyright
 */
export {
  constant1,
  constant2,
  foo,
};

yarn typedoc --entryPoints constants.d.ts

Generated doc:

See also: facebook/docusaurus#7060 and deploy preview for this bug in action.

Expected Behavior

The function foo correctly gets the doc of declaration. Variables should behave the same.

Actual Behavior

The variable constants get the doc of the export statement, which is a copyright header.

Environment

• Typedoc version: 0.22.13
• TypeScript version: 4.6.3
• Node.js version: 17.5.0
• OS: MacOS 11.6

[Gerrit0]

Duplicate of #1886, this is working as intended. You could toss a @module tag in the copyright comment, or make it a non-JSDoc comment which would prevent it from being associated with the export declaration

[Josh-Cena]

I see, thanks!

[Josh-Cena]

Is there a particular reason why doc for functions don't get overridden by the export statement comment though?

[Gerrit0]

That looks like an oversight + bug to me, didn't see it the first time I looked at it

[Gerrit0]

... and fixing it is really annoying. I'm tempted to instead make export comments only do a thing for modules/namespaces...

[Gerrit0]

I'm tempted to instead make export comments only do a thing for modules/namespaces...

Going to do this as a part of 0.23's breaking changes.