README

This is a Japanese translation of the phpDocumentor (v3.x) template.

Installation

composer require --dev sunaoka/php-documentor3-template-ja

Usage

Using Phive

phive install --force-accept-unsigned phpDocumentor
php tools/phpDocumentor \
    -d src \
    -t output --template vendor/sunaoka/php-documentor3-template-ja/default-ja

Using the PHAR

curl -L -O https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.1.0/phpDocumentor.phar
php phpDocumentor.phar \
    -d src \
    -t output --template vendor/sunaoka/php-documentor3-template-ja/default-ja

Via Docker

docker run --rm -v $(pwd):/data phpdoc/phpdoc \
    -d src \
    -t output \
    --template /data/vendor/sunaoka/php-documentor3-template-ja/default-ja

Via Composer (not recommended)

composer require --dev phpdocumentor/phpdocumentor
vendor/bin/phpdoc \
    -d src \
    -t output \
    --template vendor/sunaoka/php-documentor3-template-ja/default-ja