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

Exception "TypeError: Cannot read properties of undefined (reading 'text') at postProcessComment " #1967

Closed
doberkofler opened this issue Jun 28, 2022 · 3 comments
Labels
bug Functionality does not match expectation

Comments

@doberkofler
Copy link

doberkofler commented Jun 28, 2022

Search terms

TypeError: Cannot read properties of undefined (reading 'text')

Expected Behavior

No exception

Actual Behavior

TypeDoc exiting with unexpected error:
TypeError: Cannot read properties of undefined (reading 'text')
at postProcessComment (/Users/doberkofler/MyDev/ljs_app/trunk/periscope/node_modules/typedoc/dist/lib/converter/comments/parser.js:82:44)
at parseComment (/Users/doberkofler/MyDev/ljs_app/trunk/periscope/node_modules/typedoc/dist/lib/converter/comments/parser.js:33:5)
at getCommentWithCache (/Users/doberkofler/MyDev/ljs_app/trunk/periscope/node_modules/typedoc/dist/lib/converter/comments/index.js:26:49)
at getCommentImpl (/Users/doberkofler/MyDev/ljs_app/trunk/periscope/node_modules/typedoc/dist/lib/converter/comments/index.js:39:21)
at getComment (/Users/doberkofler/MyDev/ljs_app/trunk/periscope/node_modules/typedoc/dist/lib/converter/comments/index.js:58:12)
at Context.postReflectionCreation (/Users/doberkofler/MyDev/ljs_app/trunk/periscope/node_modules/typedoc/dist/lib/converter/context.js:122:60)
at Context.createDeclarationReflection (/Users/doberkofler/MyDev/ljs_app/trunk/periscope/node_modules/typedoc/dist/lib/converter/context.js:112:14)
at Object.convertFunctionOrMethod (/Users/doberkofler/MyDev/ljs_app/trunk/periscope/node_modules/typedoc/dist/lib/converter/symbols.js:230:32)
at convertSymbol (/Users/doberkofler/MyDev/ljs_app/trunk/periscope/node_modules/typedoc/dist/lib/converter/symbols.js:132:41)
at convertSymbols (/Users/doberkofler/MyDev/ljs_app/trunk/periscope/node_modules/typedoc/dist/lib/converter/symbols.js:138:9)

Steps to reproduce the bug

The exception does not show where the error originates from

Environment

  • Typedoc version: 0.23.2
  • TypeScript version: 4.7.4
  • Node.js version: 18.4.0
  • OS: maCOS 12.2
@doberkofler doberkofler added the bug Functionality does not match expectation label Jun 28, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 28, 2022

Oh that's fun, looks like it can be caused by this:

/**
 * @example
 */

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 29, 2022

Thought I'd be able to get this out today, but want to get #1966 in it too, so will be tomorrow

@doberkofler
Copy link
Author

Thank you for caring and all the great work you are doing

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