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

feat: update phpdocumentor to 4.0 #4040

Merged
merged 4 commits into from
Jun 23, 2021

Conversation

bshaffer
Copy link
Contributor

@bshaffer bshaffer commented May 18, 2021

This change allows documentation to be generated for PHP 7.0-only clients (such as google/cloud-compute)

Summary of changes:

  • Updates CI to only run docs generation on PHP 7.3
  • Updates CI to install phpdocumentor/reflection 4.0 before generating the docs (a bit hackish unfortunately).
  • Updates files in DocGenerator to use the new API for reflection
  • Updates misc documentation that was non-standard or incorrect

@bshaffer bshaffer requested review from a team as code owners May 18, 2021 20:42
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label May 18, 2021
// @TODO: Modified the following line so that "{}" is not replaced
// with "}". So far we have not seen any adverse effects
// $tokens[$i] = str_replace(['{@}', '{}', '%'], ['@', '}', '%%'], $tokens[$i]);
$tokens[$i] = str_replace(['{@}', '%'], ['@', '%%'], $tokens[$i]);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This entire class is here because I need to override this line.... otherwise, {} gets converted to } and never gets changed back. I opened an issue , which results in a host of issues. Removing it does not seem to have adverse effects.

I've filed an issue here: phpDocumentor/ReflectionDocBlock#276

@dwsupplee dwsupplee merged commit 3c8462c into master Jun 23, 2021
@dwsupplee dwsupplee deleted the update-phpdocumentor-to-4.0-for-docs branch June 23, 2021 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants