Doctum Laravel Package

Version 5.6.0

• Drop PHP 7.4, PHP 8.0, require PHP >= 8.1
• Attempt to reload the current page in a newly-selected version by @andrewandante in https://github.com/code-lts/doctum/pull/60
• Support PHPUnit 10, 11 and 12
• Drop PHPUnit 7 and 8
• Support nikic/php-parser v5
• Support Symfony v7 by @mtvbrianking in https://github.com/code-lts/doctum/pull/71
• Support Symfony v8
• Drop Symfony 3.4, 4.3, 5.1, 5.2, 5.3 but still support ^5.4 (LTS)
• Support missing/disabled function error_reporting
• Fix typehint resolution - stop prefixing unions with namespace by @GuySartorelli in https://github.com/code-lts/doctum/pull/77
• Fix PHP 8.5 deprecations

Highlights

• Support [@category](https://github.com/category) tags by @tillkruss in https://github.com/code-lts/doctum/pull/54
• Attempt to reload the current page in a newly-selected version by @andrewandante in https://github.com/code-lts/doctum/pull/60
• Implement phpstan doc parsing by @williamdes in https://github.com/code-lts/doctum/pull/51 (this may change the current error list)

Contributors

• @andrewandante in https://github.com/code-lts/doctum/pull/60
• @mtvbrianking in https://github.com/code-lts/doctum/pull/71
• @GuySartorelli in https://github.com/code-lts/doctum/pull/78

A big thank you to contributors that made this release possible ! Please report any new bugs.

Git Changelog: https://github.com/code-lts/doctum/compare/v5.5.4...v5.6.0

Version 5.5.4

• Fix PHP 8.2 dynamic properties for configurations with the language key (#62)

Version 5.5.3

• Fix crash with intersection types and add basic support for them (#59)

Version 5.5.2

• Fixed a JS null pointer error on Doctum.cleanSearchQuery (d5fa606806653bfffa6b17890b0d126e3df952b2) by @williamdes
• Don't inject <br> tags into <pre> for [@examples](https://github.com/examples) (#52) by @tillkruss
• Add PHP 8.2 & 8.1 to the test matrix (ac946154010c2310790184a897a1c65ae8a6ca0d)
• Fix PHP 8 "Return type mixed of method Doctum\PharFilterIterator::accept() is not covariant with tentative return type bool of method FilterIterator::accept()" (bd2115626c931616489e19fcce89482d80fabc80)

Version 5.5.1

• Allow new/more versions of symfony (^5|^6) (#45)
• Upgrade phpdocumentor/reflection-docblock to ~5.3

Version 5.5.0

• Fixed PHP errors when non configuration file was given, now it displays the error message
• Adjust error handler for PHP 8.0 silenced errors
• Fix PHP 8.1 errors on ArrayAccess methods signatures
• Fix HTML markup missing close tag <a> on a function in the global namespace (#37)
• Fix a PHP error when the [@throws](https://github.com/throws) tag is invalid
• Fix some texts that got escaped into <p> tags when it was not worth it
• Do not print the error summary for frozen versions (ex: git tags) and add CLI --print-frozen-errors to reverse this change (#33)
• Implement source line and remote links on functions of the global namespace (#38)
• Internal: rename ClassTraverser to ProjectTraverser
• Internal: add "file" and "relative_file" property on cached file for a function
• Themes: all calls to the |desc(function) filter will now need to add |md_to_html filter to convert the Markdown output to HTML
• Allow to search for non class functions on the search box and search page (#38)
• Added more strings to translate and updated the French translation
• Fixed the HTML node lang attribute according to the currently used language
• Added a version selector for small displays not having the left sidebar (#41)
• Fixed CSS striping in the left sidebar having some off-alignment with the text on some browsers (#42)
• GitLabRemoteRepository class now uses the separator /-/ in source URLs, a new constructor parameter can change this back
• AbstractRemoteRepository class now has types in the signatures
• Filter out in a non case sensitive way the tags on GitVersionCollection class and document filtering on the README
• Reduce the size of the tree, create a new class TreeNode and build the tree using JS code and not injected HTML code
• Select the global namespace in the tree while viewing it
• Disable "spellcheck", "autocorrect", "autocomplete" and "autocapitalize" on the search input
• Completely refactor the search box to drop "typeahead.js" and replace it by "autocomplete.js" (#43)
• Reduce the loading times by a lot by spliting out the search index into "doctum-search.json" and loading it only when needed (#43)
• Fix missing namespaces in the global namespace for non namespace functions (#39)
• Fixed URL encoding for versions (#32)

⚠️ Custom themes may need to add doctum-search.json in the manifest like the README examples show it

Version 5.4.1

• Fixed Search results descriptions render
• Fixed PHP 8.0 usort does not want bool anymore on GitVersionCollection setups
• Fixed CSS issues with method descriptions
• Fixed phpdoc blocks render having <code> HTML tags
• Fixed composer autoload warnings on PSR-4 classes
• Adjusted .gitattributes to exclude useless files from composer bundles
• Added tests on for the final composer package
• Support {[@link](https://github.com/link) function}, {[@link](https://github.com/link) Class::function} or {[@link](https://github.com/link) https://example.com} syntax

Version 5.3.3

LTS release (PHP 7.1 only)

• Fixed Search results descriptions render
• Fixed PHP 8.0 usort does not want bool anymore on GitVersionCollection setups
• Fixed CSS issues with method descriptions
• Fixed phpdoc blocks render having <code> HTML tags
• Fixed composer autoload warnings on PSR-4 classes
• Adjusted .gitattributes to exclude useless files from composer bundles

Version 5.3.2

LTS release (PHP 7.1 only)

• Disabled all other PHP versions for the 5.3.x series, only PHP 7.1 is allowed. Use Doctum 5.4 instead.
• Fixed a bug that removed [@return](https://github.com/return) and [@var](https://github.com/var) descriptions since 5.3.0
• Fix OpenSearch feature and documented the config
• Fix favicon config and document an example config
• Fixed global namespace handling
• Fixed a resume after parse step missing data
• Add more tests on render, parse and update CLIs
• Remove old lib michelf/php-markdown and use erusev/parsedown to fix an HTML parsing bug
• Add GitHub SECURITY and FUNDING configs
• Support UnionType of PHP 8
• Support namespace {//code} syntax for namespaces without a name

Version 5.4.0

Project related

• Add GitHub SECURITY and FUNDING configs (you can sponsor me 😉 )
• Added methods for functions to the StoreInterface class
• Changed return body of readProject method of StoreInterface to also return functions

Drop

• Drop support for PHP 7.1
• Require PHP 7.2.20
• Enable support for PHP 8.0 on the PHAR
• Drop support for phpdocumentor/reflection-docblock 4.3 series

Features

• Added detection for duplicated [@var](https://github.com/var) and [@return](https://github.com/return) tags
• Added a "version" command to avoid having users parsing unsafe output
• Added support for [@mixin](https://github.com/mixin) annotations on classes
• Added support for [@property-write](https://github.com/property-write) and [@property-read](https://github.com/property-read) annotations on classes
• Added support for [@readonly](https://github.com/readonly) annotations on methods and classes
• Added support for [@internal](https://github.com/internal) annotations on methods and classes
• Added support for [@deprecated](https://github.com/deprecated) annotations on properties
• Added support for [@since](https://github.com/since) annotations on classes, methods, properties
• Better support for [@method](https://github.com/method) annotations on classes, added static keyword support
• Add support for [@internal](https://github.com/internal), [@deprecated](https://github.com/deprecated), [@since](https://github.com/since) on constants
• Add support for [@example](https://github.com/example) on methods
• Add support for [@public](https://github.com/public), [@private](https://github.com/private), [@protected](https://github.com/protected), [@final](https://github.com/final), [@access](https://github.com/access) annotations
• Added access handling on constants
• Add Stringable PHP 8.0 class to internal PHP class list
• Add WeakReference PHP 7.4 class to internal PHP class list
• Support UnionType of PHP 8
• Support namespace {//code} syntax for namespaces without a name
• Remove old lib michelf/php-markdown and use erusev/parsedown to fix an HTML parsing bug

Bug fixes

• Fixed OpenSearch feature and documented the config
• Fixed favicon config and documented the config
• Resolve type aliases in docblocks (#23, PR: #24) thank you @CHItA for the fix
• Fixed a bug that removed [@return](https://github.com/return) and [@var](https://github.com/var) descriptions since 5.3.0
• Fixed invalid [@see](https://github.com/see) annotations parsing and rendering
• Fixed global namespace handling
• Fix some resume after parse step missing data
• Add more tests on render, parse and update CLIs

Library upgrades

• Upgrade Twig to ^3.0
• Upgrade code-lts/cli-tools to ^1.4
• Upgrade wdes/php-i18n-l10n to ^4.0

Version 5.3.1

• Fixed the missing "final" keyword on a class page
• Made the minimum required php version more precise on composer.json and README.md
• Added phar tests
• Fixed phar behavior with relative paths

Version 5.3.0

• Added: A shebang to all the new PHARs distributed
• Added: Support for a custom footer_link configuration
• Fixed: Error: The ProgressBar is not started (#19)
• Fixed: "3" [@param](https://github.com/param) tags are expected but only "4" found (#21)
• Reworked the [@param](https://github.com/param) tag error detection and added new error messages
• For custom implementations
  • Added: NodeVisitor::getPropertyReflectionFromParserProperty
  • Added: Renderer::getVariablesFromClassReflection

Version 5.2.1

• Fixed a PHP notice on "template_dirs" (#16)
• Added some more unit tests to cover some edge cases

Version 5.2.0

• Support custom composer vendor autoload files using the ENV DOCTUM_COMPOSER_AUTOLOAD_FILE
• Add function reflection & doc section in Namespace (#12)
• Refactor and improve the progress bar
• Add CLI --output-format option that supports a lot of formats: raw, rawtext, table, checkstyle, json, junit, prettyJson, gitlab, github, teamcity
• Add CLI --no-progress to disable progress bars but keep output
• Fixed --no-ansi not displaying text
• RENDER_PROGRESS callback takes $this->step, $this->steps instead of $this->getProgression() for users hacking the tool
• PARSE_CLASS callback uses $this->step, $this->steps instead of the calculated progression
• Most error reports are sent to stderr now, you can use --no-progress --output-format=checkstyle 2> checkstyle.xml
• Add new dependency code-lts/cli-tools

Version 5.1.0

• Allow symfony/* ~3.4 versions
• Support --ignore-parse-errors to have an exit code 0.
• Add more PHP typehints on the code-base.

The artifacts below where updated after the release to support PHP 7.1 (01a60d34d52b218450782687f69a9319e976670f)

Version 5.0.3

• Some fixes for project classes

Version 5.0.2

• Upgrade nikic/php-parser from 4.5.x to 4.6.x
• Add an error for PHP versions below 7.1
• Fixed an error due to #249 on phpdocumentor/reflection-docblock

Version 5.0.1

• Fix a parsing error on "src/Parser/NodeVisitor"

Version 5.0.0

• Forked the project
• Removed all GIT tags
• Migrated from TravisCI to GitHub actions
• Improved README
• Improved CHANGELOG
• Moved tests to tests directory
• Removed symfony/phpunit-bridge in favor of phpunit/phpunit
• Removed blackfire testing
• Updated composer.json
• Move source files to src directory
• Rename Sami to Doctum
• Move the binary to bin/doctum.php
• Add phpstan
• Fix some issues reported by phpstan
• Upgrade nikic/php-parser from ~3.0 to ~4.5
• Upgrade twig/twig from ~2.0 to ~2.12
• Apply some coding standard rules on the code-base
• Add PHP constants visibility
• Drop simulate_namespaces config option
• #7 - Translate Doctum, thank you @Guileas
• Support 'language' in the configuration block, available languages are ('fr' and 'en') for now, default 'en'.
• #6 - Upgrade phpdocumentor/reflection-docblock from ~2.0 to ~5.1
• Clean the .css .js vendor files
• Re-build the font using https://fontello.com/
• #4 - build a release process and phar bundling