Skip to content

Comments in re-export erases documentation #1886

@DavidPeicho

Description

@DavidPeicho

Search terms

missing, erase, comments

Expected Behavior

Consider the following file:

query.ts

/*
 * This query is awesome!
 *
 * @category Query
 */
export class Query { }

index.ts

/**
 * This comment will erase the Query doc, ho snap! :(
 */

export * from './query.ts'

The documentation that will be generated for the Query class should be This query is awesome!

Actual Behavior

The documentation that appears is the one from the comment before the re-export: This comment will erase the Query doc, ho snap! :(

Steps to reproduce the bug

It's easy to reproduce with the exact two same files I gave in the Expected Behavior section.

Environment

  • Typedoc version: 0.22.13
  • TypeScript version: 4.6.2
  • Node.js version: 17.2.0
  • OS: Windows WSL

Metadata

Metadata

Assignees

No one assigned

    Labels

    no bugThis is expected behavior

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions