Skip to content
This repository was archived by the owner on Oct 30, 2024. It is now read-only.

Commit b2453aa

Browse files
committed
PHP API Documentation
* Generate phpdoc api documentation with 'make phpdoc' * Serve this documentation with 'make serve-phpdoc' Needs Graphviz installed to proper generate charts and python to serve the local directory through HTTP.
1 parent 54e4150 commit b2453aa

2 files changed

Lines changed: 10 additions & 1 deletion

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ cover
66
/composer.phar
77
/phpDocumentor.phar
88
/composer.lock
9+
/docs/api
910
build
1011
.idea

Makefile

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ bdd:
1919

2020
cover:
2121
./vendor/bin/phpunit --coverage-html ./cover test
22+
2223
deps:
2324
wget -q https://getcomposer.org/composer.phar -O ./composer.phar
2425
chmod +x composer.phar
@@ -29,11 +30,18 @@ dist-clean:
2930
rm -rf vendor
3031
rm -f composer.phar
3132
rm -f composer.lock
33+
rm -f phpDocumentor.phar
34+
rm -rf docs/api
3235

3336
docker-nats:
3437
docker run --rm -p 8222:8222 -p 4222:4222 -d --name nats-main nats
3538

3639
phpdoc:
37-
wget -q http://phpdoc.org/phpDocumentor.phar -O ./phpDocumentor.phar
40+
wget -q https://github.com/phpDocumentor/phpDocumentor2/releases/download/v2.9.0/phpDocumentor.phar -O ./phpDocumentor.phar
41+
chmod +x phpDocumentor.phar
42+
./phpDocumentor.phar -d ./src/ -t ./docs/api --template=checkstyle --template=responsive-twig
43+
44+
serve-phpdoc:
45+
cd docs/api && python -m SimpleHTTPServer
3846

3947
.PHONY: lint test cs cover deps dist-clean

0 commit comments

Comments
 (0)