From d702b21bf7010867288f45f0ac029a942e3980d8 Mon Sep 17 00:00:00 2001 From: Jens True Date: Mon, 22 Jan 2024 12:09:20 +0000 Subject: [PATCH] Added PHPdoc. --- .gitignore | 7 ++-- composer.json | 2 +- composer.lock | 90 +++++++------------------------------------------ phpdoc.dist.xml | 18 ++++++++++ 4 files changed, 33 insertions(+), 84 deletions(-) create mode 100644 phpdoc.dist.xml diff --git a/.gitignore b/.gitignore index 1025c97..6aac50d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,6 @@ -coverage -nbproject -.idea .vscode vendor -bin .phpunit.cache -composer.phar +*.phar +.phpdoc/ output/ \ No newline at end of file diff --git a/composer.json b/composer.json index 1b4e1f9..ce709c3 100644 --- a/composer.json +++ b/composer.json @@ -8,7 +8,6 @@ "require-dev": { "phpunit/phpunit": "^10", "phpstan/phpstan": "^1", - "laravel/pint": "^1", "squizlabs/php_codesniffer": "*", "vimeo/psalm": "^5.14" }, @@ -25,6 +24,7 @@ "scripts": { "test": "vendor/bin/phpunit tests --display-warnings", "test-coverage": "vendor/bin/phpunit tests --testdox --coverage-filter src --coverage-html output/coverage --coverage-text --testdox-html output/test.html --log-junit output/test.xml", + "document": "./phpDocumentor.phar", "analyze": [ "@analyze-phpstan", "@analyze-psalm", diff --git a/composer.lock b/composer.lock index 6777d6d..7917df3 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "085ab396d73220eb11e38aa5bc71e6b9", + "content-hash": "667bb75c25a72b3d35f64ada9d9d9e0d", "packages": [], "packages-dev": [ { @@ -637,72 +637,6 @@ ], "time": "2023-09-17T21:38:23+00:00" }, - { - "name": "laravel/pint", - "version": "v1.13.8", - "source": { - "type": "git", - "url": "https://github.com/laravel/pint.git", - "reference": "69def89df9e0babc0f0a8bea184804a7d8a9c5c0" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/laravel/pint/zipball/69def89df9e0babc0f0a8bea184804a7d8a9c5c0", - "reference": "69def89df9e0babc0f0a8bea184804a7d8a9c5c0", - "shasum": "" - }, - "require": { - "ext-json": "*", - "ext-mbstring": "*", - "ext-tokenizer": "*", - "ext-xml": "*", - "php": "^8.1.0" - }, - "require-dev": { - "friendsofphp/php-cs-fixer": "^3.46.0", - "illuminate/view": "^10.39.0", - "larastan/larastan": "^2.8.1", - "laravel-zero/framework": "^10.3.0", - "mockery/mockery": "^1.6.7", - "nunomaduro/termwind": "^1.15.1", - "pestphp/pest": "^2.30.0" - }, - "bin": [ - "builds/pint" - ], - "type": "project", - "autoload": { - "psr-4": { - "App\\": "app/", - "Database\\Seeders\\": "database/seeders/", - "Database\\Factories\\": "database/factories/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Nuno Maduro", - "email": "enunomaduro@gmail.com" - } - ], - "description": "An opinionated code formatter for PHP.", - "homepage": "https://laravel.com", - "keywords": [ - "format", - "formatter", - "lint", - "linter", - "php" - ], - "support": { - "issues": "https://github.com/laravel/pint/issues", - "source": "https://github.com/laravel/pint" - }, - "time": "2024-01-09T18:03:54+00:00" - }, { "name": "myclabs/deep-copy", "version": "1.11.1", @@ -1580,16 +1514,16 @@ }, { "name": "phpunit/phpunit", - "version": "10.5.7", + "version": "10.5.8", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit.git", - "reference": "e5c5b397a95cb0db013270a985726fcae93e61b8" + "reference": "08f4fa74d5fbfff1ef22abffee47aaedcaea227e" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/e5c5b397a95cb0db013270a985726fcae93e61b8", - "reference": "e5c5b397a95cb0db013270a985726fcae93e61b8", + "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/08f4fa74d5fbfff1ef22abffee47aaedcaea227e", + "reference": "08f4fa74d5fbfff1ef22abffee47aaedcaea227e", "shasum": "" }, "require": { @@ -1661,7 +1595,7 @@ "support": { "issues": "https://github.com/sebastianbergmann/phpunit/issues", "security": "https://github.com/sebastianbergmann/phpunit/security/policy", - "source": "https://github.com/sebastianbergmann/phpunit/tree/10.5.7" + "source": "https://github.com/sebastianbergmann/phpunit/tree/10.5.8" }, "funding": [ { @@ -1677,7 +1611,7 @@ "type": "tidelift" } ], - "time": "2024-01-14T16:40:30+00:00" + "time": "2024-01-19T07:07:27+00:00" }, { "name": "psr/container", @@ -3546,16 +3480,16 @@ }, { "name": "vimeo/psalm", - "version": "5.19.0", + "version": "5.20.0", "source": { "type": "git", "url": "https://github.com/vimeo/psalm.git", - "reference": "06b71be009a6bd6d81b9811855d6629b9fe90e1b" + "reference": "3f284e96c9d9be6fe6b15c79416e1d1903dcfef4" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/vimeo/psalm/zipball/06b71be009a6bd6d81b9811855d6629b9fe90e1b", - "reference": "06b71be009a6bd6d81b9811855d6629b9fe90e1b", + "url": "https://api.github.com/repos/vimeo/psalm/zipball/3f284e96c9d9be6fe6b15c79416e1d1903dcfef4", + "reference": "3f284e96c9d9be6fe6b15c79416e1d1903dcfef4", "shasum": "" }, "require": { @@ -3652,7 +3586,7 @@ "issues": "https://github.com/vimeo/psalm/issues", "source": "https://github.com/vimeo/psalm" }, - "time": "2024-01-09T21:02:43+00:00" + "time": "2024-01-18T12:15:06+00:00" }, { "name": "webmozart/assert", diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml new file mode 100644 index 0000000..991c33e --- /dev/null +++ b/phpdoc.dist.xml @@ -0,0 +1,18 @@ + + + backupscript + + output/docs + + + + + src + + + + \ No newline at end of file