-
Notifications
You must be signed in to change notification settings - Fork 805
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
Added parsing of PHPDoc blocks based on AST and PHPDoc parser by phpstan. #41306
base: trunk
Are you sure you want to change the base?
Conversation
Thank you for your PR! When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:
This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖 The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available. Follow this PR Review Process:
Still unsure? Reach out in #jetpack-developers for guidance! |
continue; | ||
} | ||
|
||
$paramTags = $phpDocNode->getParamTagValues(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@since
and @module
tags will have to be added separately.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can confirm it generates both a phpdoc.json
and a markdown.json
. I'm not familiar enough with AST parsing to be confident as to whether it's doing what it should at a low level, though.
I'll note that there are two deprecation notices from the scribu
library, and several instances of this:
Warning: DOMDocument::loadHTML(): Tag summary invalid in Entity, line: 376 in /some/path/jetpack/tools/cli/helpers/doc-parser/runner.php on line 72
Proposed changes:
phpstan/phpdoc-parser
.apply_filters
calls using AST and PHPDoc parsing usingphpdoc-parser
.Other information:
Jetpack product discussion
Does this pull request change what data or activity we track or use?
No.
Testing instructions:
jetpack docs
phpdoc.json
file generated in the folder where you're running the command from.