difflens[bot]
commented
2 months ago View changes in DiffLens
Closed renovate[bot] closed 2 months ago
difflens[bot]
commented
2 months ago View changes in DiffLens
deepsource-io[bot]
commented
2 months ago Here's the code health analysis summary for commits 782d487..9ae172b. View details on DeepSource ↗.
| Analyzer | Status | Summary | Link |
|---|---|---|---|
 Docker | ✅ Success | View Check ↗ | |
 Terraform | ✅ Success | View Check ↗ | |
 Ruby | ✅ Success | View Check ↗ | |
 Scala | ✅ Success | View Check ↗ | |
 Python | ✅ Success | View Check ↗ | |
 Ansible | ✅ Success | View Check ↗ | |
 Go | ✅ Success | View Check ↗ | |
 PHP | ✅ Success | View Check ↗ | |
 Rust | ✅ Success | View Check ↗ | |
 Shell | ✅ Success | View Check ↗ | |
 SQL | ✅ Success | View Check ↗ | |
 Secrets | ✅ Success | View Check ↗ | |
 Java | ✅ Success | View Check ↗ | |
 JavaScript | ✅ Success | View Check ↗ | |
 C# | ✅ Success | View Check ↗ |
💡 If you’re a repository administrator, you can configure the quality gates from the settings.
difflens[bot]
commented
2 months ago View changes in DiffLens
difflens[bot]
commented
2 months ago View changes in DiffLens
This PR contains the following updates:
3.4.3->3.5.0Release Notes
phpDocumentor/phpDocumentor (phpdocumentor/phpdocumentor)
### [`v3.5.0`](https://togithub.com/phpDocumentor/phpDocumentor/releases/tag/v3.5.0) [Compare Source](https://togithub.com/phpDocumentor/phpDocumentor/compare/v3.4.3...v3.5.0) ##### Guides, php 8.3 and more! In this new release of phpDocumentor you will find a large number of improvements and new added support for php language constructs. But also a large number of improvements to write better and more useful documentation for your fellow developers. ##### Guides 1.3 We have been working very hard together with the Typo3 Documentation team, but also with members of the Doctrine and Symfony project to stabilize the ReStructuredText support in phpDocumentor. The release the [first stable version](https://www.linkedin.com/feed/update/urn:li:activity:7170173363275943936/) was a few months ago and was already included in the docker image we publish on docker hub. But wasn't part of a tagged release yet, until now. The new version is better in almost every perspective. We will keep tuning and improving the guides project. ##### Class list directive A new directive added in this version the dynamic class list. In many situations I found my self creating list of classes implementing a certain interface to describe they are available for certain purpose. But I also wrote documentation above each class. So why not combining those? .. phpdoc:class-list:: [?(@.inheritedElement == "\phpDocumentor\Transformer\Writer\WriterAbstract")] .. phpdoc:name:: .. phpdoc:summary:: https://docs.phpdoc.org/guide/internals/templates/index.html#templates ##### Class diagrams Another directive we added is the class diagram directive. phpDocumentor could already create a class diagram out of your full code base. But for larger projects this was barely useful. The new class diagram directive allows you to select a number of classes and create a diagram out of those. For example to just select the domain of your application or any other specify system that you want to visualize. .. phpdoc:class-diagram:: [?(@.namespace starts_with "\phpDocumentor\Descriptor")] https://docs.phpdoc.org/guide/hand-written-docs/directives.html#directives ##### Attributes PHP introduced attributes in php 8. We did never add them to the API documentation because it didn't seem to add value. Now attributes are more widely adopted in the eco system we are also introducing them into phpDocumentor. Right now we will only display them as elements on the API docs, but more improvements will follow.  ##### Other changes ##### Template extension since the release of the v3 series we have been working on our new `default` template and make it as easy as possible to extend that template, by [changing the color scheme](https://docs.phpdoc.org/guide/features/theming/changing-the-color.html#changing-the-color) adding [custom css](https://docs.phpdoc.org/guide/features/theming/custom-styling.html#custom-styling) and even replacing full components in the template. But in some cases this isn't enough. You want to add custom reports or other pages, in this version we added [template extending](https://docs.phpdoc.org/guide/features/theming/extending-a-template.html#extending-a-template). When you extend an existing template you can still use the power off all the features we had before, but also include more customizations overviews and more. ##### In development ##### Extensions We are working on a new way to extend phpDocumentor. In our vision phpDocumentor will become a documentation framework. Because we know more about the code base than what you write down in the docblocks. Example usecase for extensions are custom writers, that allow you to not just write to file but push your documentation to a api? Extract all hooks from your wordpress plugins and more? This feature is currently in development, and will be extended more. With the goal to make phpDocumentor an even more useful tool in our toolbox. ##### Markdown support Markdown is a very common format to write documents. We do see more value in RST but as many people are using markdown to write docs we are also adding CommonMark support to phpDocumentor. The feature set of markdown will be limited, but you might find it working for you. ##### Other note worthy changes - Do not install with untrusted signature through PHIVE by [@ravage84](https://togithub.com/ravage84) in [https://github.com/phpDocumentor/phpDocumentor/pull/3597](https://togithub.com/phpDocumentor/phpDocumentor/pull/3597) - Fix: resolves issue with varidict arguments by [@jaapio](https://togithub.com/jaapio) in [https://github.com/phpDocumentor/phpDocumentor/pull/3600](https://togithub.com/phpDocumentor/phpDocumentor/pull/3600) - Feat: Add filter for var tags on groups by [@jaapio](https://togithub.com/jaapio) in [https://github.com/phpDocumentor/phpDocumentor/pull/3602](https://togithub.com/phpDocumentor/phpDocumentor/pull/3602) - Fix: add resolver for methods and properties by [@jaapio](https://togithub.com/jaapio) in [https://github.com/phpDocumentor/phpDocumentor/pull/3614](https://togithub.com/phpDocumentor/phpDocumentor/pull/3614) - Upgrade guides to latest version by [@jaapio](https://togithub.com/jaapio) in [https://github.com/phpDocumentor/phpDocumentor/pull/3619](https://togithub.com/phpDocumentor/phpDocumentor/pull/3619) - Upgrade guides to 2023-12-13 version by [@jaapio](https://togithub.com/jaapio) in [https://github.com/phpDocumentor/phpDocumentor/pull/3627](https://togithub.com/phpDocumentor/phpDocumentor/pull/3627) - Add directive to list classes by their parent by [@jaapio](https://togithub.com/jaapio) in [https://github.com/phpDocumentor/phpDocumentor/pull/3631](https://togithub.com/phpDocumentor/phpDocumentor/pull/3631) - Fix single command run by [@jaapio](https://togithub.com/jaapio) in [https://github.com/phpDocumentor/phpDocumentor/pull/3634](https://togithub.com/phpDocumentor/phpDocumentor/pull/3634) - Fix wrong value for visibility option in XSD by [@sebastian-meyer](https://togithub.com/sebastian-meyer) in [https://github.com/phpDocumentor/phpDocumentor/pull/3663](https://togithub.com/phpDocumentor/phpDocumentor/pull/3663) - Fix wrong value for visibility option in XSD by [@sebastian-meyer](https://togithub.com/sebastian-meyer) in [https://github.com/phpDocumentor/phpDocumentor/pull/3666](https://togithub.com/phpDocumentor/phpDocumentor/pull/3666) - Fix Psalm issue by [@sebastian-meyer](https://togithub.com/sebastian-meyer) in [https://github.com/phpDocumentor/phpDocumentor/pull/3672](https://togithub.com/phpDocumentor/phpDocumentor/pull/3672) - Small improvements to guide rendering by [@sebastian-meyer](https://togithub.com/sebastian-meyer) in [https://github.com/phpDocumentor/phpDocumentor/pull/3671](https://togithub.com/phpDocumentor/phpDocumentor/pull/3671) - Add test for Guides Compiler by [@mvriel](https://togithub.com/mvriel) in [https://github.com/phpDocumentor/phpDocumentor/pull/3676](https://togithub.com/phpDocumentor/phpDocumentor/pull/3676) - Add test for DescriptorRepository by [@mvriel](https://togithub.com/mvriel) in [https://github.com/phpDocumentor/phpDocumentor/pull/3675](https://togithub.com/phpDocumentor/phpDocumentor/pull/3675) - Add CSS background colour for body by [@DanielSiepmann](https://togithub.com/DanielSiepmann) in [https://github.com/phpDocumentor/phpDocumentor/pull/3680](https://togithub.com/phpDocumentor/phpDocumentor/pull/3680) - Changing GitHub Action entrypoint format by [@vcampitelli](https://togithub.com/vcampitelli) in [https://github.com/phpDocumentor/phpDocumentor/pull/3685](https://togithub.com/phpDocumentor/phpDocumentor/pull/3685) - Checking if the template location was provided before parsing it by [@vcampitelli](https://togithub.com/vcampitelli) in [https://github.com/phpDocumentor/phpDocumentor/pull/3686](https://togithub.com/phpDocumentor/phpDocumentor/pull/3686) - \[DOCS] Fix generating-documentation.rst by [@justbyitself](https://togithub.com/justbyitself) in [https://github.com/phpDocumentor/phpDocumentor/pull/3687](https://togithub.com/phpDocumentor/phpDocumentor/pull/3687) - fix: typo in CI docs by [@stobrien89](https://togithub.com/stobrien89) in [https://github.com/phpDocumentor/phpDocumentor/pull/3690](https://togithub.com/phpDocumentor/phpDocumentor/pull/3690) - fix: typo in the typo fix by [@stobrien89](https://togithub.com/stobrien89) in [https://github.com/phpDocumentor/phpDocumentor/pull/3691](https://togithub.com/phpDocumentor/phpDocumentor/pull/3691) - Update Twitter icon to X by [@fulldecent](https://togithub.com/fulldecent) in [https://github.com/phpDocumentor/phpDocumentor/pull/3693](https://togithub.com/phpDocumentor/phpDocumentor/pull/3693) - Remove note about future v3 release by [@fulldecent](https://togithub.com/fulldecent) in [https://github.com/phpDocumentor/phpDocumentor/pull/3696](https://togithub.com/phpDocumentor/phpDocumentor/pull/3696) - Phpunit upgrade by [@jaapio](https://togithub.com/jaapio) in [https://github.com/phpDocumentor/phpDocumentor/pull/3712](https://togithub.com/phpDocumentor/phpDocumentor/pull/3712) - Fix issue with inheritance order by [@jaapio](https://togithub.com/jaapio) in [https://github.com/phpDocumentor/phpDocumentor/pull/3713](https://togithub.com/phpDocumentor/phpDocumentor/pull/3713) - Inherit method documentation through multiple generations by [@smaddock](https://togithub.com/smaddock) in [https://github.com/phpDocumentor/phpDocumentor/pull/3701](https://togithub.com/phpDocumentor/phpDocumentor/pull/3701) - Add gpg key to install instruction, fixes [#3694](https://togithub.com/phpDocumentor/phpDocumentor/issues/3694) by [@fulldecent](https://togithub.com/fulldecent) in [https://github.com/phpDocumentor/phpDocumentor/pull/3699](https://togithub.com/phpDocumentor/phpDocumentor/pull/3699) - Add tests for Version Compiler Passes and refactor TableOfContentsBuilder by [@mvriel](https://togithub.com/mvriel) in [https://github.com/phpDocumentor/phpDocumentor/pull/3677](https://togithub.com/phpDocumentor/phpDocumentor/pull/3677) - Bump to fixed reflection docblock by [@jaapio](https://togithub.com/jaapio) in [https://github.com/phpDocumentor/phpDocumentor/pull/3718](https://togithub.com/phpDocumentor/phpDocumentor/pull/3718) ##### New Contributors - [@ravage84](https://togithub.com/ravage84) made their first contribution in [https://github.com/phpDocumentor/phpDocumentor/pull/3597](https://togithub.com/phpDocumentor/phpDocumentor/pull/3597) - [@sebastian-meyer](https://togithub.com/sebastian-meyer) made their first contribution in [https://github.com/phpDocumentor/phpDocumentor/pull/3663](https://togithub.com/phpDocumentor/phpDocumentor/pull/3663) - [@DanielSiepmann](https://togithub.com/DanielSiepmann) made their first contribution in [https://github.com/phpDocumentor/phpDocumentor/pull/3680](https://togithub.com/phpDocumentor/phpDocumentor/pull/3680) - [@vcampitelli](https://togithub.com/vcampitelli) made their first contribution in [https://github.com/phpDocumentor/phpDocumentor/pull/3685](https://togithub.com/phpDocumentor/phpDocumentor/pull/3685) - [@justbyitself](https://togithub.com/justbyitself) made their first contribution in [https://github.com/phpDocumentor/phpDocumentor/pull/3687](https://togithub.com/phpDocumentor/phpDocumentor/pull/3687) - [@stobrien89](https://togithub.com/stobrien89) made their first contribution in [https://github.com/phpDocumentor/phpDocumentor/pull/3690](https://togithub.com/phpDocumentor/phpDocumentor/pull/3690) - [@fulldecent](https://togithub.com/fulldecent) made their first contribution in [https://github.com/phpDocumentor/phpDocumentor/pull/3693](https://togithub.com/phpDocumentor/phpDocumentor/pull/3693) - [@smaddock](https://togithub.com/smaddock) made their first contribution in [https://github.com/phpDocumentor/phpDocumentor/pull/3701](https://togithub.com/phpDocumentor/phpDocumentor/pull/3701) **Full Changelog**: https://github.com/phpDocumentor/phpDocumentor/compare/v3.4.3...v3.5.0Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.