All Versions
53
Latest Version
Avg Release Cycle
75 days
Latest Release
224 days ago

Changelog History
Page 1

  • v5.5.1 Changes

    February 17, 2022
    • ๐Ÿ‘ Allow new/more versions of symfony (5|6)
    • โฌ†๏ธ Upgrade phpdocumentor/reflection-docblock to ~5.3
  • v5.5.0 Changes

    January 09, 2022
    • ๐Ÿ›  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
    • ๐Ÿ›  Fix a PHP error when the @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
    • Implement source line and remote links on functions of the global namespace
    • 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
    • โž• 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
    • ๐Ÿ›  Fixed CSS striping in the left sidebar having some off-alignment with the text on some browsers
    • 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"
    • โฌ‡๏ธ Reduce the loading times by a lot by spliting out the search index into "doctum-search.json" and loading it only when needed
    • ๐Ÿ›  Fix missing namespaces in the global namespace for non namespace functions
  • v5.4.1 Changes

    April 22, 2021
    • ๐Ÿ›  Fixed Search results descriptions render
    • ๐Ÿ›  Fixed PHP 8.0 usort does not want a boolean 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 function}, {@link Class::function} or {@link https://example.com} syntax
  • v5.4.0 Changes

    April 10, 2021
    • โฌ‡๏ธ Drop support for PHP 7.1
    • โฌ‡๏ธ Drop support for phpdocumentor/reflection-docblock 4.3 series
    • Require PHP 7.2.20
    • ๐Ÿ‘ Enable support for PHP 8.0 on the PHAR
    • Resolve type aliases in docblocks (#24)
    • โฌ†๏ธ Upgrade Twig to ^3.0
    • โฌ†๏ธ Upgrade code-lts/cli-tools to ^1.4
    • โฌ†๏ธ Upgrade wdes/php-i18n-l10n to ^4.0
    • ๐Ÿ›  Fixed a bug that removed @return and @var descriptions since 5.3.0
    • โž• Added detection for duplicated @var and @return tags
    • โž• Added a "version" command to avoid having users parsing unsafe output
    • โž• Added support for @mixin annotations on classes
    • โž• Added support for @property-write and @property-read annotations on classes
    • โž• Added support for @readonly annotations on methods and classes
    • โž• Added support for @internal annotations on methods and classes
    • โž• Added support for @deprecated annotations on properties
    • โž• Added support for @since annotations on classes, methods, properties
    • ๐Ÿ‘ Better support for @method annotations on classes, added static keyword support
    • โž• Add support for @internal, @deprecated, @since on constants
    • โž• Add support for @example on methods
    • ๐Ÿ›  Fix OpenSearch feature and document the config
    • ๐Ÿ›  Fix favicon config and document an example config
    • โž• Add support for @public, @private, @protected, @final, @access annotations
    • ๐Ÿ›  Fixed invalid @see annotations parsing and rendering
    • โž• Added access handling on constants
    • ๐Ÿ›  Fixed global namespace handling
    • โž• Added methods for functions to the StoreInterface class
    • ๐Ÿ”„ Changed return body of readProject method of StoreInterface to also return functions
    • ๐Ÿ›  Fix some 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
    • โž• 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
  • v5.3.3 Changes

    April 21, 2021

    ๐Ÿš€ LTS release (PHP 7.1 only)

    • ๐Ÿ›  Fixed Search results descriptions render
    • ๐Ÿ›  Fixed PHP 8.0 usort does not want a boolean 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
  • v5.3.2 Changes

    April 12, 2021

    ๐Ÿš€ LTS release (PHP 7.1 only)

    • Disabled all other PHP versions for the 5.3.x series, only PHP 7.1 is allowed
    • ๐Ÿ›  Fixed a bug that removed @return and @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
  • v5.3.1 Changes

    December 30, 2020
    • ๐Ÿ›  Fixed: missing "final" keyword on a class page
    • Made the minimum required php version more precise on composer.json and README.md
  • v5.3.0 Changes

    December 20, 2020
    • โž• Added: NodeVisitor::getPropertyReflectionFromParserProperty
    • โž• Added: Renderer::getVariablesFromClassReflection
    • ๐Ÿ›  Fixed: "Error: The ProgressBar is not started" (#19)
    • ๐Ÿ›  Fixed: ""3" @param tags are expected but only "4" found" (#21)
    • Reworked the @param tag error detection and added new error messages
    • โž• Added: A shebang to all the new PHARs distributed
    • โž• Added: Support for a custom footer_link configuration
  • v5.2.1 Changes

    November 30, 2020
    • ๐Ÿ›  Fixed a PHP notice on "template_dirs" (#16)
    • โž• Added some more unit tests to cover some edge cases
  • v5.2.0 Changes

    November 29, 2020
    • 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