Fix docs parser crash when prop.tags is undefined (#15764) #15792
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixed docs parser crash when prop.tags is undefined (#15764)
Problem
The documentation parser in
docs/source/api.jscrashes with aTypeError: Cannot read properties of undefined (reading 'Symbol(Symbol.iterator)')when processing JSDoc comments that don't have tags. This causes the entire documentation build process to fail.Root Cause
At line 273 in
docs/source/api.js, the code attempts to iterate overprop.tagswithout checking if it exists:When the
doxparser encounters JSDoc comments without tags,prop.tagsisundefined, causing the iterator to fail.Solution
Added a defensive check before the iteration to skip properties without tags:
This allows the parser to gracefully skip entries without tags while continuing to process properly documented code.