« Changelog History


APIGen v5.0.0-RC1 Release Notes

Release Date: 2017-07-02 // almost 7 years ago

  • ➕ Added

    • 📦 #863 Added Annotation package
    • ➕ Added Element package
    • ➕ Added ModularConfiguration package
    • ➕ Added Reflection package
    • 📦 #858 Added StringRouting package
    • ➕ Added .editorconfig to the project
    • 👍 #704 Added support for static type
    • 👍 #731 Added bitcoin link support via @link bitcoin:address
    • ➕ Added theme option to load theme from directory
    • ➕ Added phpDocumentor/TypeResolver for type resolving
    • ➕ Added phpDocumentor/ReflectionDocBlock for annotation parsing
    • ➕ Added Symplify/EasyCodingStandard to make coding standard powerful
    • ➕ Added phpstan for static analysis checks

    🔄 Changed

    • 🔄 #827 Changed PHP Token Reflection library from andrewsville/php-token-reflection to roave/better-reflection
    • Minimum PHP requirement was increased from 5.4 to 7.1
    • 🔧 #880 Change DI library from Nette\DI to Symfony\DependencyInjection due to Symfony 3.3 new features and PSR-11
    • Project is now PSR-2 compatible
    • 0️⃣ #64 UTF-8 is now a standard/default charset. [ApiGen] will expect UTF-8 encoded files by default
    • #771 Only relevant classes are generated in sidebar and source code pages
    • Enabled autocomplete for methods and properties
    • 🔀 #814 #862 ThemeDefault and ThemeBootstrap merged to one local theme, with support of Bootstrap 3
      and mobile-friendly design
    • #823 @internal annotation cannot be ignored now
    • 🔀 #826 Long and short description merged to one, since there was thin and not clear line between them
    • #818 #827 Class<Generator,Reflection> split to Class, Trait and Interface with own type-specific methods
    • 🚚 #845 #845 SourceCodeGenerator dropped and moved to particular reflection generators (ClassGenerator...)
    • 🔀 #855 Indirect and direct users/implementers/inheritors merged to one group
    • #858 Tree and Namespace filters simplified
    • #862 Standardize use of annotations
    • 🚚 #860 Left sidebar removed, it duplicated main content and had complicated tree structures
    • #749 Don't fully qualify local members

    🛠 Fixed

    • 🚚 #520 Fixed an issue with temporary files not being removed upon exit (in cases where failure happens)
    • 🛠 #631 Fixed an issue with generate command throwing an error
    • 🏁 #804 Fixed tests (and hopefully compatibility) on Windows OS
    • 🛠 Fixed deprecation checks when generating docs
    • 🛠 Fixed issues with exception handling in low-level parser
    • 🛠 Fixed an error on generating docs for non-existent traits
    • 🏁 #668 Fixed an issue with handling paths on different OS. The paths should now be normalized and work on Windows
    • 🛠 #740 Fixed an issue where ApiGen sometimes would incorrectly resolve return typehints for functions
    • 🛠 #734 Fixed an issue when docblocks marked with @internal would be documented
    • 🛠 #750 Fixed support of $this as return type hint
    • 🛠 #848 Fixed missing methods in class
    • 🛠 #717 Fixed duplicated function source code

    📜 PHP 5.5, 5.6 and 7 and parsing related Fixes

    • 🛠 #620 Fixed composed trait methods
    • #774 Fixed default constant value and __DIR__ constant parsing
    • 🛠 #751 Fixed broken function definition
    • 📜 #680 Fixed ::class parsing

    ✂ Removed

    • #826 --main option dropped
    • #813 Magic elements dropped
    • 0️⃣ --charset CLI option has been dropped (expecting UTF-8 now by default)
    • --skip-doc-path CLI option has ben dropped
    • #827 --template-config and --template-theme dropped
    • #853 --exclude and --extensions options dropped (use FinderInterface implementation instead)
    • ✂ Removed various deprecated generators (Robots, Sitemap) which weren't used
    • #809 Tree generator dropped
    • ⬇️ Dropped Zip generator, internet is quite fast nowadays.
    • ⬇️ Dropped PHAR support.
    • 👻 #827 Exception element dropped
    • ⬇️ Dropped element js toggling in page, was bugged and was causing confused page jumps.
    • 📚 Dropped support for global constant documentation, as BetterReflection doesn't support it out of the box yet.

    Full diff: v4.1.2...v5.0.0-RC1