Skip to content

Find a replacement for Sami? #5

@danmichaelo

Description

@danmichaelo

Sami has been deprecated, but I wasn't able to find a good replacement for it.

phpDox almost completely lacks documentation and provides very limited functionality out of the box. I was able to connect it to phploc, but not to coverage reports. No error messages, just 0 % coverage, despite the coverage reports themselves looking OK. After reading several through issues on github I gave up. The HTML output also looks dated and less appealing than the output from Sami.

phpDocumenter seems to be the main candidate. The clean template looks quite good, not too different from Sami. On the negative side, it doesn't play well with composer. Pear is a no-go, but it also provides a phar package and I just learned that there is a tool called phive to manage phar packages:

phive --no-progress install --trust-gpg-keys 86BED3D6EFA8B121 phpDocumentor

But it installs 2.9 and phpDocumenter 2 doesn't seem to support PHP 7 fully. PhpDocumenter 3, on the other hand, is in alpha 3 and has been in development for years.

wget https://github.com/phpDocumentor/phpDocumentor2/releases/download/v3.0.0-alpha.3/phpDocumentor.phar
wget https://github.com/phpDocumentor/phpDocumentor2/releases/download/v3.0.0-alpha.3/phpDocumentor.phar.pubkey
php phpDocumentor.phar -d src -t docs

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions