Skip to content

v3.5.0-rc

Pre-release
Pre-release
Compare
Choose a tag to compare
@jaapio jaapio released this 24 May 13:41
· 131 commits to master since this release
v3.5.0-rc
1408c1a
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.

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: v3.4.3...v3.5.0

Contributors

mvriel, DanielSiepmann, and 8 other contributors
Assets 4
Loading