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

• Add used-by resolving by @jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3198
• Query engine for AST by @jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3172
• Rfc/3154 full line and column location of methods by @LeoVie in https://github.com/phpDocumentor/phpDocumentor/pull/3214
• Support null versions in Since reflection by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3286
• Source code cannot be viewed from packages, file or namespaces by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3284
• When typing an array, show that in docs by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3293
• GH#3307 Make readonly mutator for class available by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3362

Template

• Tighten table of contents by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3382
• Introduce the first value objects by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3381
• Show 'On this page' for classes and namespaces by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3383
• Restyle elements and add color support by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3388
• Do not show container section of TOC in classes by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3380
• Back to top doesn't work in Guides by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3391
• Show whether a method is tagged as 'api' by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3392
• Show Constants on Traits in the Trait's documentation by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3394
• Move headerlinks to component by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3404
• feat: preserve newlines in XML attributes by @bshaffer in https://github.com/phpDocumentor/phpDocumentor/pull/3430
• Including Punctuation Marks by @BirdboyBolu in https://github.com/phpDocumentor/phpDocumentor/pull/3439
• feat: add support for APP_CACHE_DIR and APP_LOG_DIR by @drupol in https://github.com/phpDocumentor/phpDocumentor/pull/3518
• feat: add class magic methods to xml template, fix magic method return tag by @bshaffer in https://github.com/phpDocumentor/phpDocumentor/pull/3514
• Add callable rendering by @jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3538
• Feature/filesource tag by @jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3539
• feat: add magic flag to xml template by @bshaffer in https://github.com/phpDocumentor/phpDocumentor/pull/3520

Fixed

• fix: ensure uses/see/link descriptors render to string as expected by @bshaffer in https://github.com/phpDocumentor/phpDocumentor/pull/3244
• Fix OutputHello Example Param Wording by @CraicOverflow89 in https://github.com/phpDocumentor/phpDocumentor/pull/3324
• Fix issue with minimal directory by @jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3325
• Fix: remove redundant whitespace by @kudashevs in https://github.com/phpDocumentor/phpDocumentor/pull/3335
• Docker shouldn't run help run by default by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3285
• Levenshtein argument too long by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3287
• References to cases are not linked by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3288
• Purge caches upon version change by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3289
• Extend timeout for UML generation to 20mins by @Hackwar in https://github.com/phpDocumentor/phpDocumentor/pull/3311
• Should fix #3415 by @peterhauke in https://github.com/phpDocumentor/phpDocumentor/pull/3441
• Resolve issue invalid property definition by @jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3479
• Bugfix/3494 ignore symlinks by @jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3495

Docs

• Start documenting pipelines and remove obsolete pipeline by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3483
• [DOCS] Link to configuration chapter by @linawolf in https://github.com/phpDocumentor/phpDocumentor/pull/3489
• [DOCS] Fix indentation to make code-blocks render by @linawolf in https://github.com/phpDocumentor/phpDocumentor/pull/3490

CI

• More strict argument check by @jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3195
• Reintroduce composer require checker by @jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3133
• Line numbers show 0 with InvalidTag issues by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3294
• Windows tests keep failing by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3295
• GH Actions: bust the cache semi-regularly by @jrfnl in https://github.com/phpDocumentor/phpDocumentor/pull/3357
• Start building on php 8.2 by @jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3376
• Use centralized phar build by @jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3529
• Comment use of unreleased method from ReflectionDocBlock by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3364
• Moved most parts of the DescriptorAbstract and TagDescriptor into traits by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3375
• Introduce CanHaveAType and CanHaveADefaultValue traits for Descriptors by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3379

Other

• Refactor LinkRenderer into a series of adapters and introduce references to guides by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3475
• Warn when multiple versions and/or sets of each type is given by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3477
• Move Files listing from Project to Documentation Sets by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3480
• Move indexes from Project to Documentation Sets by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3481
• Remove file and index getters and setters from project by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3482
• Extract pipeline for documentation set by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3485
• Collect files and indexes in API Documentation Set by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3486
• Cache per documentation set by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3487
• Move compiling into a pipeline by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3488
• Refactor all compilers to work on a DocumentationSet by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3492
• Change writers to be performed on a per-documentation-set basis by @mvriel in https://github.com/phpDocumentor/phpDocumentor/pull/3496
• Drop php 7.4 and php 8.0 by @jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3510
• Restructure compiler to allow different stages by @jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3519
• Php upgrade by @jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3540
• Chore: upgrade to symfony 6 by @jaapio in https://github.com/phpDocumentor/phpDocumentor/pull/3541

New Contributors

• @LeoVie made their first contribution in https://github.com/phpDocumentor/phpDocumentor/pull/3214
• @wouterj made their first contribution in https://github.com/phpDocumentor/phpDocumentor/pull/3218
• @bshaffer made their first contribution in https://github.com/phpDocumentor/phpDocumentor/pull/3244
• @amayer5125 made their first contribution in https://github.com/phpDocumentor/phpDocumentor/pull/3312
• @Hackwar made their first contribution in https://github.com/phpDocumentor/phpDocumentor/pull/3311
• @CraicOverflow89 made their first contribution in https://github.com/phpDocumentor/phpDocumentor/pull/3324
• @kudashevs made their first contribution in https://github.com/phpDocumentor/phpDocumentor/pull/3335
• @BirdboyBolu made their first contribution in https://github.com/phpDocumentor/phpDocumentor/pull/3439
• @peterhauke made their first contribution in https://github.com/phpDocumentor/phpDocumentor/pull/3441
• @linawolf made their first contribution in https://github.com/phpDocumentor/phpDocumentor/pull/3489
• @drupol made their first contribution in https://github.com/phpDocumentor/phpDocumentor/pull/3518

Full Changelog: https://github.com/phpDocumentor/phpDocumentor/compare/v3.3.1...v3.4.0-rc