Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Only first warning is shown by TypeDoc #1981

Closed
doberkofler opened this issue Jul 3, 2022 · 1 comment
Closed

Only first warning is shown by TypeDoc #1981

doberkofler opened this issue Jul 3, 2022 · 1 comment
Labels
bug Functionality does not match expectation

Comments

@doberkofler
Copy link

Search terms

warning Encountered an unescaped open brace without an inline tag
warning Unmatched closing brace

Expected Behavior

All warnings should be show and not only the first one (related to #1979)

Actual Behavior

When the following type of warnings is shown, only the first one is shown instead of all of them.
After the code has been changed to @param data - The given contact values typedoc must be run again to see the next warning.

./src/components/contacts/index.ts:95:40 - warning Encountered an unescaped open brace without an inline tag
95 * @param {contactData.dataType} [data={}] - The given contact values

./src/components/contacts/index.ts:95:41 - warning Unmatched closing brace
95 * @param {contactData.dataType} [data={}] - The given contact values

Steps to reproduce the bug

export class ContactManagement {
	/**
	 * Constructor for the Contact management object.
	 *
	 * @param {contactData.dataType} [data={}] - The given contact values <--- line 95
	 */
	public constructor(data: contactData.contactValueType = {}) {
        }
}

Environment

  • Typedoc version: 0.23.5
  • TypeScript version: 4.7.4
  • Node.js version: 18.4.0
  • OS: maCOS 12.2
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jul 6, 2022

Aww shoot, looks like this is fallout from nearly a year ago when I added logic to not report duplicate warnings... I didn't take into account warnings with a location attached.

@Gerrit0 Gerrit0 closed this as completed in fdd8238 Jul 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

2 participants