Improved parallelization

• supports parallel analysis in addition to parallel rendering
• no longer requires pcntl extension
• works on Windows as well

Other Improvements

• adds support for object shapes
• supports min & max keywords in integer ranges

Bugfixes

• fixes an error that occurs when the index is empty

Improvements

• support default types for generic parameters
• support @template-contravariant tags
• print variance information of generic types
• print sealed information of array shapes
• print kind information of array shapes
• resolve 'parent' and 'self' keyword
• support more keywords when resolving php doc
• add robots=noindex to pages of non-primary elements
• render sitemap.xml
• emit error when source file is not UTF-8 encoded

Bugfixes

• fix error when Index was empty
• fix highlight 'match' as keyword
• fix various missing spaces when printing type

Improvements

• add support for type aliases
• do not emit missing symbols warning for vendor files
• improve const expression types printing

Bugfixes

• fix StringExprInfo encoding

Rewritten to be based on nikic/php-parser and phpstan/phpdoc-parser with full support of PHP 8.1 features.

Features

• phpDoc
  • all types supported by PHPStan
  • generic class declarations
• PHP 8.1
  • enums
  • pure intersection types
  • never type
  • final class constants
  • new in initializers
  • readonly properties
• PHP 8.0
  • constructor property promotion
  • union types
  • mixed type
  • static return type
• PHP 7.4
  • typed properties

Install

With Docker

ApiGen is available as apigen/apigen Docker image which you can directly use.

docker run --rm --interactive --tty --volume "$PWD:$PWD" --workdir "$PWD" \
  apigen/apigen \
  src --output docs

With Phar

This will install ApiGen phar binary to tools/apigen.

mkdir -p tools
curl -L https://github.com/ApiGen/ApiGen/releases/download/v7.0.0-alpha/apigen.phar -o tools/apigen
chmod +x tools/apigen
tools/apigen src --output docs

With Composer

This will install ApiGen to tools/apigen directory with executable entry point available in tools/apigen/bin/apigen.

composer create-project --no-dev apigen/apigen:^7.0@alpha tools/apigen
tools/apigen/bin/apigen src --output docs

If you are interested in ApiGen behind-scene @tomasvotruba wrote a post about ApiGen 5 revival process: https://www.tomasvotruba.cz/blog/2017/09/04/how-apigen-survived-its-own-death/

Added

• @vlastavesely added as a co-maintainer, thanks to his great additions to the project 👏

• #971 Added resolving parent classes, Thanks to @vlastavesely

• #987 Improve parsing by BetterReflection by Caching, make use of https://github.com/Roave/BetterReflection/pull/312; also decouple BetterReflection subpackage and turn static to DI

Changed

• #977, #978 Updated to EasyCodingStandard 2.2.6 with new checkers
• #990 Improve ProjectVendorSourceLocatorFactory readability, Thanks @simara-svatopluk

Fixed

• #974 Deprecate all subelements of deprecated classes, interfaces and traits, Thanks to @vlastavesely
• #980 Fixed line wraps in source code (css), Thanks to @vlastavesely
• #972 Fixed __CLASS__ parsing, see https://github.com/Roave/BetterReflection/pull/298, Thanks to @vlastavesely

Full diff: https://github.com/ApiGen/ApiGen/compare/v5.0.0-RC4...v5.0.0-RC5

Added

• #926 Initial support for ReflectionConstant, Thanks @POPSuL also for extensive PR to BetterReflection repository
• #959 Added ValueDumper, Thanks @vlastavesely
• #958 Added support for interface constants, Thanks @vlastavesely
• #970 Added ApiGen Docs DEMO - to be found at https://apigen.github.io/ApiGen

Changed

• #956 Reflection: allowed nullable filenames for internal reflections, Thanks @vlastavesely
• #969 Upgraded to EasyCodingStandard 2.2

Fixed

• #955 RelativePathResolver: fix for functions loaded from file source, Thanks @vlastavesely
• #957 Parser: fixed file source loader, Thanks @vlastavesely
• #954 Deprecated methods of deprecated interface, Thanks @vlastavesely
• #969 Lock Roave\BetterReflection to specific commit to prevent breaking the code

Full diff: https://github.com/ApiGen/ApiGen/compare/v5.0.0-RC3...v5.0.0-RC4

Huge thanks to @vlastavesely for dozens of PR to this release!
Your work is pushing this repository fast forward.

Added

• #944 Added support for FileLocator; Thanks to @vlastavesely

  vendor/bin/apigen generate src/Directory src/SomeClass.php --destination /api
  

• #940 Added support for traits with properties; Thanks to @vlastavesely
• #916 Added support different vendor analysis by adding a ComposerSourceLocator; Thanks to @vlastavesely
• #946 Added highlighting of method's param default value; Thanks to @vlastavesely
• #932 Added autocomplete search; Thanks to @vlastavesely and also to @POPSuL

Changed

• #934 Disabled function param sorting + fixed function.latte; Thanks to @vlastavesely
• #943 Minor improvement in 'finished' msg; Thanks to @nelson6e65
• #933 Use local copy of jQuery; Thanks to @vlastavesely

Fixed

• #950 Fixed link generation for type hints; Thanks to @vlastavesely
• #952 Fixed @see/@link annotation for links and not elements.
• #941 Fixed improper parent class retrieval; Thanks to @vlastavesely
• #939 #953 Fixed strike outs for deprecated elements; Thanks to @vlastavesely
• #925 Theme: fixed whitespace wrapping for long description; Thanks to @vlastavesely
• #927 Fixed console progressbar overflow; Thanks to @vlastavesely

Full diff: https://github.com/ApiGen/ApiGen/compare/v5.0.0-RC2...v5.0.0-RC3

Added

• #888 more informative information added on --version call in CLI; Thanks to @brunoaugusto
• #895 implemented TraitMethodReflection::isDeprecated(); Thanks to @vlastavesely
• #923 used local Bootstrap CSS for more flexible local development; Thanks to @vlastavesely
• #919 added exception standalone page via ExceptionGenerator + separation from classes in NamespaceGenerator; Thanks to @vlastavesely

Changed

• #918 use Coveralls for coverage over Scrutinizer

Fixed

• #917 fixed removing internal classes for NamespaceGenerator
• #905 StepCounter improvements; Thanks to @vlastavesely
• #898 fixed source code highlighting templates; Thanks to @vlastavesely
• #921, #892, #904 fixed autoloading for composer create-project ... and composer global require ... command and added tests for them; Thanks to @brunoaugusto and @nelson6e65
• #891, #893 fixed trait name in template; Thanks to @vlastavesely

Thank you all guys for great work. I'm very happy to see such activity around this project! ❤️

Full diff: https://github.com/ApiGen/ApiGen/compare/v5.0.0-RC1...v5.0.0-RC2

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
• #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
• --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: https://github.com/ApiGen/ApiGen/compare/v4.1.2...v5.0.0-RC1

Fixed

• Fixed issued when parsing configuration array when using phar #564

Full diff: https://github.com/ApiGen/ApiGen/compare/v4.0.0...v4.0.1

Fixed

• #590 Fix issue with ThemeConfigPathResolver for vendor

Full diff: https://github.com/ApiGen/ApiGen/compare/v4.1.0...v4.1.1

Minor fixes

Full diff: https://github.com/ApiGen/ApiGen/compare/v4.1.1...v4.1.2

Added

• #573 --config now supports YAML format, thanks to @trong
• #536 --source option now accepts single files
• #539 --annotation-groups options added, to generate pages with single annotation (e.g. for todo: --annotation-groups=todo)
  • before:
    • --todo --deprecated (only these two)
  • now:
    • --annotation-groups todo,deprecated
    • --annotation-groups event,api

Changed

• #550 wiping out destination is now protected by asking
• #523 when page from --annotation-groups has no items, info message is displayed
• #504 themes decoupled to standalone packages
• [https://github.com/ApiGen/ThemeBootstrap/pull/3] Bootstrap theme was updated to Twitter Bootstrap 3, thanks to @olvlvl
• #507 use Box for PHAR compiling

Fixed

• #545 missloading of class list in layout panel
• #526 Exceptions were displayed instead of interfaces, thanks to @jrnickell
• #530 --source-code options should be --no-source-code, thanks to @yoosefi
• #538 spaces from apigen.services.neon removed, thanks to @ramsey
• #575 function link fixed

Docs

• https://github.com/ApiGen/ApiGen/blob/master/CONTRIBUTING.md contributing info added
• https://github.com/ApiGen/ApiGen/blob/master/UPGRADE-4.0.md upgrade from 2.8 to 4.0 info added

Full diff: https://github.com/apigen/apigen/compare/v4.0.1...v4.1.0

Why Skip 3.0?

Version 3.0 was skipped, because master branch had 3.0-dev alias with code
base similar to 2.8. Since then there were many BC breaks, thus major version was bumped to 4.0.

This release closes refactoring of version 2.8. Its aim was to improve code base, provide fairly high code coverage (from 0 % in 2.8) to improve further development and close old pull-requests. Now it's at 84 %, which really makes changes easier.

Saying that, next version will focus on:

• new features based on issues/PR from you, end users.
• website management
• package decoupling
• documentation

Changes

• [#492] use "dash" type (BC for 2.8)
• [#493] support for various CLI option input format
• https://github.com/apigen/apigen/commit/8bf2325c4d5768aa8633d33da0a1c99d94dd85a9 php is now off by default, turn it on by --php
• https://github.com/apigen/apigen/commit/0cc7640b5dc2e38c79b6f884fee5bd292af34bb4 Kdyby\Console removed
• https://github.com/apigen/apigen/commit/91d5e6b911f07454ce8734c798e2806dca571df5 autocomplete option dropped - to much detailed was use-non-friendly
• https://github.com/apigen/apigen/commit/c749343881b86cbbb857ff69a1961d18040e131e self-update command now uses https://github.com/herrera-io/php-phar-update

Bugfixes

• [#490] reading options from apigen.neon fixed
• [#434] PHAR installation simplified and fixed for cross platform
• [#465] relative path on Windows fixed
• [#375] constant version returned, so now it's available in composer installed packages as well

Full diff: https://github.com/apigen/apigen/compare/v4.0.0-RC5...v4.0.0

How to Upgrade

• Default command generate added:

  Before:

  apigen -s source -d destination

  After:

  apigen generate -s source -d destination

• New command self-update added, to upgrade .phar file.

  Before:

  manual update

  After:

  apigen self-update

• Bool options for arguments passed via CLI are off when absent, on when
  present.

  Before:

  ... --tree yes # tree => true

  ... --tree no # tree => false

  After:

  ... --tree # tree => true

  ... # tree => false

• Options with values for arguments passed via CLI now accept multiple formats:

  Before:

  ... --access-levels public --access-levels protected

  After:

  ... --access-levels public,protected

  or

  ... --access-levels="public,protected"

  or

  ... --access-levels public --access-levels protected

• Some CLI options were dropped. To see what the available ones are, just run apigen generate --help.

  • --skip-doc-prefix was dropped, use --skip-doc-path instead
  • --allowed-html was dropped
  • --autocomplete was dropped; autocomplete now works for classes, constants and functions by default
  • --report; use Php_CodeSniffer for any custom checkstyle
  • --wipeout; now wipes out everytime
  • --progressbar; now always present
  • --colors; now always colors
  • --update-check; update manually by apigen self-update (new version is released every ~ 2 months)

• Some CLI options were renamed and reversed.

  • --source-code was off by default, now it on by default; to turn it off, add --no-source-code

New features

• [#470] Generator decoupled to TemplateGenerators, standalone classes that generate only particular part of elements
• https://github.com/apigen/apigen/commit/3b89201b42aad34a0c118bfd6c685443d23db838 PHPUnit is now used for tests as more understandable to many progammers
• https://github.com/apigen/apigen/commit/ce18ba4edc24940365e32fb38af776ea90bd6a2c code coverage added, from 0 % just three months ago, it's 33 % for this release
• [#456] ThemeConfig added, makes it easier to create custom templates, mention only differences
• [#457] bump to min version PHP 5.4 [BC break]

Changes

• https://github.com/apigen/apigen/commit/8b1132d595db1adffe665afabcc0c2fc2fd3e883 GenerateCommand doesn't write to config anymore
• https://github.com/apigen/apigen/commit/64af2c2e0483794fd6dc63693bbcf8cafd79f82f 'main', 'optional' and 'common' sections removed and it's content moved to 'templates' [BC break]
• [#459, #422] returned formed CLI options
• [#460, #424] source code is back optional
• [#468] CharsetConvertor decoupled to standalone extension
• https://github.com/apigen/apigen/commit/72e6492b87f1344b41a39f1c4908041bd4d08f43 dropped scanning phar, not useful [BC break]
• https://github.com/apigen/apigen/commit/3569725a1b26a3ce49f2440f0acf7184d6061af0 dropped skipDocPrefix as confusing, use skipDocPath as regular expression standard [BC break]

Bugfixes

• [#373] escaped HTML code in parameter list
• [#423, #437] Reflection: functions are never loaded https://github.com/apigen/apigen/commit/493aff0d49e6e16066fa846c82a2ba225112e46d
• [#445] 'mixed' is not 'undefined'
• [#475] Function with arguments throws exception
• [#473] The option "autocomplete" does not exist.
• [#467] Generator not working: mb_substr_count expects at most 3 parameters, 4 given
• [#466] Composer install failing on OS X

Full diff: https://github.com/apigen/apigen/compare/v4.0.0-RC4...v4.0.0-RC5

New features

• https://github.com/apigen/apigen/commit/87018aa9c7b5ce7719871003b72844870613f555 - Code Sniffer added
• some tests added

Changes

• https://github.com/apigen/apigen/commit/4016bc305c0a1e029986139ae99c2a395ae4f754 - system dir is now used for caching (instead of working path)
• https://github.com/apigen/apigen/commit/0b5b75b7be7057b82bff08dd4adec59bdcc8243a - Scanner now uses Nette\Utils\Finder
• https://github.com/apigen/apigen/commit/6a4ea735907489f1a0617bb5c2a237d4e75dc718 - Parses progress bar is measured by file count (file size before), since such detail has almost no added value
• https://github.com/apigen/apigen/commit/4a26624a4e60f637c9d8e160e15a7136a62d070a - MemoryLimitCheck removed, https://github.com/apigen/apigen/commit/152c66cff444ae47426bbccf91cb9bc646c3213f - automatic setup used instead (Composer inspired)

Bugfixes

• [#394, #407] quiet option for empty CLI output fixed
• [#396, #399] self-update command fixed
• [#384] package link fixed
• https://github.com/apigen/apigen/commit/a562f3d3634960a840b6946cbd37549ba8723245 relative paths on Windows fixed
• [#412] exclude mask now only applies on current dir
• [#408] "located" paths cut out fixed
• [#416] link to method start anchor fixed
• [#432] purge method fixed

Full diff: https://github.com/apigen/apigen/compare/v4.0.0-RC3...v4.0.0-RC4

New features

• [#382] selfupdate command for phar added, will download most up-to-date stable version
• [#364] --working-dir option added, same functionality as Composer

Changes

• https://github.com/apigen/apigen/commit/bcebc185b522836781dbc590b3abde4baeca09c4 - progress bar simplified

Bugfixes

• [#390] duplicate return values
• [#385] allow renamed apigen.phar to apigen
• [#373] method params contained line numbers
• [#257] traits methods are not displayed
• [#234] allow using traits outside source
• https://github.com/apigen/apigen/commit/03880df8455286d9c02f41b1b5e698e6bd18ae52 - theme choser fixed

Full diff: https://github.com/apigen/apigen/compare/v4.0.0-RC2...v4.0.0-RC3

Changes:

• SourceCodeHilighter: new method highlightAndAddLineNumbers() decoupled from highlight() method bool param

Bugfixes:

• [#366] Filter 'resolveElement' is not defined + test added
• [#365] Undefined variable: namespaces + test added
• [#362] Problems with default values + test added
• GenerateCommand error output broken style

Full diff: https://github.com/apigen/apigen/compare/v4.0.0-RC1...v4.0.0-RC2

New features

• phar installation added (via vendor/bin/compile at the moment) [WIP]
• Symfony\Console added
• Kdyby\Events added
• Nette DI added

BC breaks

• default markup is now Markdown using michelf\php-markdown
• dropped PEAR support
• dropped options:
  • allowed-html
  • source-code (link to source code is now always displayed)
  • report
  • wipeout
  • quiet
  • progressbar (always displayed)
  • colors
  • update-check

Full diff: https://github.com/apigen/apigen/compare/v2.8.1...v4.0.0-RC1

• Updated TokenReflection library to 1.0.0beta5
• Requires FSHL 2.0.0RC
• Fixed url in footer