fix: allow decorator syntax in code comments during yui doc processing #9097
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6662826 to
9b56d46
Compare
This is a fix for decorator handling in code comment blocks that is part of https://github.com/cibernox/ember-cli-yuidoc and is what allows ember.js yui doc generation to handle decorator syntax. See: https://github.com/cibernox/ember-cli-yuidoc/blob/master/lib/broccoli-yuidoc.js
9b56d46 to
fc36f2e
Compare
runspired
approved these changes
Nov 13, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This is a fix for decorator handling in code comment blocks. This introduces part of https://github.com/cibernox/ember-cli-yuidoc, a dep of ember.js and is what processes the ember.js docs and allows ember.js yui doc generation to handle decorator syntax. Since we have our own bespoke doc compilation process in EmberData that the addon doesn't address, we are introducing this 1 change here rather than adding
ember-cli-yuidocitself as a dependency.See: https://github.com/cibernox/ember-cli-yuidoc/blob/master/lib/broccoli-yuidoc.js
This also fixes a few code blocks that were unclosed and only became exposed in failing tests once decorators were being handled properly and the docs were fully building (previously we were missing some of the code comments in docs because of the decorator issue).
BEFORE:
AFTER: