Skip to content

Latest commit

 

History

History
117 lines (59 loc) · 2.86 KB

UPGRADE-4.0.md

File metadata and controls

117 lines (59 loc) · 2.86 KB

Upgrade from 2.x to 4.0

Version

  • 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, there for naming it 4.0.

PHP version

  • Min PHP version was raised:

    Before: 5.3

    After: 5.4

Distribution

  • PEAR support was dropped. Use PHAR file instead. Latest stable version can be always found at apigen.org

  • New Release process was established. Releasing minor version every 2 months.

Cli commands

  • Symfony\Console replaced custom CLI solution, thus composer-like approach is used. In particular, you need to call specific command name in first argument.

    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

Cli options

  • Bool options 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 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 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 options were renamed and reversed.

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

Markup

Coding standard

Tests

  • From no tests to unit testing with PHPUnit. With decent coverage of ~80 %.

  • Part of continuous integration testing by Travis CI.