Skip to content

Releases: code-lts/doctum

v5.5.4

16 Dec 22:10
v5.5.4
fbece8c
Compare
Choose a tag to compare

Version 5.5.4

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

v5.5.3

10 Oct 23:39
v5.5.3
4b5013b
Compare
Choose a tag to compare

Version 5.5.3

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

v5.5.2

12 Mar 13:42
v5.5.2
4256170
Compare
Choose a tag to compare

Version 5.5.2

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

v5.5.1

17 Feb 15:42
v5.5.1
ae16945
Compare
Choose a tag to compare

Version 5.5.1

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

v5.5.0

09 Jan 22:06
v5.5.0
05d1c28
Compare
Choose a tag to compare

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

v5.4.1

21 Apr 23:57
v5.4.1
aba1c34
Compare
Choose a tag to compare

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 function}, {@link Class::function} or {@link https://example.com} syntax

v5.3.3

21 Apr 22:35
v5.3.3
8e1076f
Compare
Choose a tag to compare

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

v5.3.2

12 Apr 01:41
v5.3.2
7322763
Compare
Choose a tag to compare

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

10 Apr 01:22
v5.4.0
38c478f
Compare
Choose a tag to compare

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 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
  • Add support for @public, @private, @protected, @final, @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 and @var descriptions since 5.3.0
  • Fixed invalid @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

v5.3.1

30 Dec 13:13
v5.3.1
b7e2ffb
Compare
Choose a tag to compare

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