Skip to content

Update dependency phpdocumentor/phpdocumentor to v3 #33

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update dependency phpdocumentor/phpdocumentor to v3 #33

wants to merge 1 commit into from

Conversation

@specmatic-builder
Copy link

@specmatic-builder specmatic-builder commented Jul 26, 2025

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
phpdocumentor/phpdocumentor (source) 2.* -> 3.* age adoption passing confidence

Release Notes

phpDocumentor/phpDocumentor (phpdocumentor/phpdocumentor)

v3.8.1

Compare Source

Bugfix release

Thanks a lot for all contributions.

New Contributors

Full Changelog: phpDocumentor/phpDocumentor@v3.8.0...v3.8.1

v3.8.0

Compare Source

What's Changed

This release comes with support for asymmetric visibility on properties and support for property hooks. Property hooks were introduced in php 8.4. The system generating your documentation doesn't have to be running php 8.4 to be able to display property hooks.

by @​jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3926

image

Traits using traits

Since the introduction of traits, you can use traits in traits. However this was never reflected properly in phpDocumentor. By now methods imported by a trait in a trait are shown in the documentatation of your trait.

by @​jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3931

Filter private elements

Inheritance did not work as it should be, by now private elements are not longer inherited by child classes and traits.

by @​jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3932

Fixes bugs

Documentation

Other changes

New Contributors

Full Changelog: phpDocumentor/phpDocumentor@v3.7.1...v3.8.0

v3.7.1

Compare Source

What's Changed

Full Changelog: phpDocumentor/phpDocumentor@v3.7.0...v3.7.1

v3.7.0

Compare Source

3.7.0

This release is mostly a maintenance release. With some small improvements on the output of phpDoc on the cli. And internal upgrades of a number of dependencies. Most note worthy changes are listed in these release notes.

Clean template refactoring

Thanks to @​omegamvc the clean template has been updated to work better on mobile devices and new features added to the default template for api docs have been added. This is a huge step forward in the clean template. The work has not been finished yet. So more will follow in the future.

PHP 8.3 and PHP 8.4 support

phpDocumentor is now executable on php 8.3 and 8.4 This does not mean we have support for all language additions yet. As we told in the previous release notes the impact of php 8.4 is very big. A lot of changes have to be done to be able to support php 8.4 language features.

Improved config options for plantuml

Since a few releases phpDocumentor is using plantuml to generate diagrams. However some users did experience issues when using the phar install of phpDocumentor. While to docker based installations did work as expected. To make it possible again to generate diagrams using the phar based installations we did add some new options. These new options will allow you to install plantuml on your system and point phpdocumentor to the correct location. The options are added to the docs: https://docs.phpdoc.org/guide/guides/generate-diagrams.html#generate-diagrams

[BETA] Custom twig extensions

We did introduce an extension system to phpDocumentor a few releases ago. However there was no real working use-case for extensions yet. In this release we did add an example on how to extend phpDocumentor with a custom twig extension. More extension points will be added in the future. If you want to create your own twig extension read the guide on how to do that: https://docs.phpdoc.org/guide/features/extensions/twig-extension.html#twig-extension

Other changes

New Contributors

Full Changelog: phpDocumentor/phpDocumentor@v3.6.0...v3.7.0

v3.6.0

Compare Source

What's Changed

In this release a number of bugfixes have been added and two major new features. We are still working on php 8.3 and 8.4 support to ensure our users are able to upgrade. But due to the large changes that are required with the new property hooks in php 8.4 and async property accessors a lot of work has to be done. Neverless we are very happy to provide you this new release which will definitely help you to document your projects even better.

Markdown support

Most important change in this release is the introduction of markdown support in guides. Before phpDocumentor did only have support for ReStructedText in the manuals. By now we also support markdown. The syntax of markdown is not as extendable as the RST syntax is. Therefor the more advanced features like class listing and automated diagrams are not supported yet. But for most common usecases markdown will work.

Improved class diagrams

In this release we added an improved version of the class diagram generation. We extended the way we generate diagrams, so external classes are now better visible. And also the style of traits in the class diagram has been improved. We are planning to add more options and allow users to get more control over the generated diagram, by filtering out certain elements.

Other changes:

New Contributors

Full Changelog: phpDocumentor/phpDocumentor@v3.5.3...v3.6.0

v3.5.3

Compare Source

v3.5.3

Full Changelog: phpDocumentor/phpDocumentor@v3.5.2...v3.5.3

v3.5.2

Compare Source

Fix regression introduced in v3.5.1 regarding command parsing.

v3.5.1

Compare Source

#v3.5.1

This bugfix release includes 2 small bugfixes regarding the cli options you can pass to phpdoc. before we supported phpdoc run -d ./src and phpdoc -d ./src both would do exactly the same. During a change in the previous version the first way of doing things was broken. Now this has been restored. Including the option to list possible settings with --list-settings

Also included is a new way of rendering the new php 8.4 #[Deprecated] attribute as well the improved rendering of deprecated methods and classes.

Full change list:

New Contributors

Full Changelog: phpDocumentor/phpDocumentor@v3.5.0...v3.5.1

v3.5.0

Compare Source

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 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.

image

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 adding custom css 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. 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

New Contributors

Full Changelog: phpDocumentor/phpDocumentor@v3.4.3...v3.5.0

v3.4.3

Compare Source

Fix regression in guides by @​jaapio

Full Changelog: phpDocumentor/phpDocumentor@v3.4.2...v3.4.3

v3.4.2

Compare Source

What's Changed

Experimental

Full Changelog: phpDocumentor/phpDocumentor@v3.4.0...v3.4.2

v3.4.1

Compare Source

Fixes

  • Issue when renaming the phar, see #​3562.

v3.4.0

Compare Source

What's new in phpDocumentor 3.4.0

Our ReStructuredText library as taken flight. It's now a separate library and can be used in any project. As
it is getting more and more traction the library is becoming more feature complete and stricter accoring to the RST spec.
This allows you to write better documentation for your users but also improved the readability of our own docs.

Changelogs of the guides library are not included in these release notes.

General changes

In this release we dropped PHP 7 support completely, we upgraded to Symfony 6 and added support for php 8.2
Interally we have restructured the pipelines to prepare for multi version support in the future.

Added

Template

Fixed

Docs

CI

Other

New Contributors

Full Changelog: phpDocumentor/phpDocumentor@v3.3.1...v3.4.0-rc

v3.3.1

Compare Source

Fixed

CI

New Contributors

Full Changelog: phpDocumentor/phpDocumentor@v3.3.0...v3.3.1

v3.3.0

Compare Source

This version doesn't contain any functional changes regarding v3.2 but has some internal updates to allow support for php 8.1.

Check the v3.2.0 release notes for more information about what is new.

v3.2.1

Compare Source

Bugfix release for broken phar in v3.2.0

v3.2.0

Compare Source

This release has two main focus points. We invested a lot of time to improve the guides feature, which is still under heavy development, and php 8.1 support.

php version drops.

Last release supporting php 7.2 and 7.3

Guides

  • Render external uml diagrams. you can now reference to external puml files to render a diagram in your guides.
  • Improved memory usage
  • Improved ReStructuredText support.

php 8.1

phpDocumentor has now support for php 8.1 elements. Because of some external dependencies we were not able yet to support phpDocumentor running on php 8.1.

  • Enum support
  • read only properties
  • return type never
  • final constants

New Contributors

Full Changelog: phpDocumentor/phpDocumentor@v3.1.2...v3.2.0

v3.1.2

Compare Source

Fixes shim release

v3.1.1

Compare Source

Fixed

  • Add workaround for phar distribution and plantuml, thanks to Jaapio
  • XML template invalid XML due to missing marker.type, #​2986, thanks to Jaapio
  • Class's traits not showing up in docs, #​2984, thanks to Jaapio
  • Files with forced global namespace fail with "" is not a valid Fqsen, #​2967, thanks to Jaapio
  • XML output missing method tags, #​2965, thanks to Jaapio

CI

  • Updated code style checks, thanks to jrfnl

v3.1.0: : php8, guides & stability

Compare Source

After the release of v3.0.0, which was a huge step forward for phpDocumentor, we started focussing on a new big step. The 3.1 release is not complete as we had in mind, but it will provide you with some new stuff which will improve your documentation.

PHP8 support

This version of phpDocumentor is fully compatible with PHP8. To support all additional features in PHP8 we had to redesign part of our internal reflection library, which is now capable to read and document constructor promoted properties, mixed, static and union type hints.
We have rewritten some internals in phpDocumentor to fix compatibility issues between the supported PHP versions and our dependencies which are not always supporting the range of PHP versions supported by phpDocumentor.

Bug fixes & Improvements

Thanks to all contributors who reported their issues with phpDocumentor v3.0 we could improve. So please keep reporting your bugs and missing features so we can continue this path. Please consult the change log for the full list of fixed issues.

Guides (Unstable)

In v3 we started working on handwritten documentation. In this version we continued that feature, by extending it with Admonitions, diagrams and images. We cleaned up a lot of the parser code to make the guides parsing fit better in our internal workflow with the final result where your api and handwritten docs are fully integrated to provide the best possible documentation for your code consumers.

Guides are still under heavy development, please consider them unstable as the api will change and we will extend the number of features in future versions of phpDocumentor.

Documentation improvements

In this release, several documentation sections are added. We continue to improve our own documentation while we are improving phpDocumentor itself to render our own docs. Our docs are a good show-case of what phpDocumentor is currently capable to do.

Thank you

Configuration

📅 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.

  • If you want to rebase/retry this PR, check this box

This PR has been generated by Renovate Bot. Specmatic specific configuration is managed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

dependency renovate

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@specmatic-builder