Skip to content

Commit

Permalink
Added phpdoc.
Browse files Browse the repository at this point in the history
  • Loading branch information
GeertHauwaerts committed Apr 24, 2019
1 parent ee2200f commit 4528c9d
Show file tree
Hide file tree
Showing 7 changed files with 474 additions and 7 deletions.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
composer.lock
phpunit.xml
.phpunit.result.cache
vendor/
src/voipbl.conf
src/localbl.db
src/voipbl.db
docs/php/build/
vendor/
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ when to use API acknowledgements.

## Library Usage

Instead of using the `voipbl.php` file, you can use the `ExaBGP\VoIPBL` classes independently.
Instead of using the `voipbl.php` file, you can use the `ExaBGP\VoIPBL` classes independently. Check the
[ExaBGP\VoIPBL library documentation](docs/php/README.md) for the list of functions and their arguments.

```php
use ExaBGP\VoIPBL\Loader;
Expand Down Expand Up @@ -57,12 +58,13 @@ $version = $controller->sendCommand('version', true);

## Development & Testing

To verify the integrity of the codebase you can run the PHP linter and unit tests:
To verify the integrity of the codebase you can run the PHP linter, unit tests, and update the library documentation:

```
$ composer install
$ ./vendor/bin/phpunit
$ ./vendor/bin/phpcs --standard=phpcs.xml --extensions=php src/ tests/
$ composer phpunit
$ composer phpcs
$ composer phpdoc
```

## Collaboration
Expand Down
8 changes: 8 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,20 @@
"php": ">=7.0"
},
"require-dev": {
"cvuorinen/phpdoc-markdown-public": ">=0.2",
"jms/serializer": "^1.7",
"squizlabs/php_codesniffer": ">=3.0",
"phpdocumentor/phpdocumentor": ">=2.9",
"phpunit/phpunit": ">=8.0"
},
"autoload": {
"psr-4": {
"ExaBGP\\": "src/ExaBGP/"
}
},
"scripts": {
"phpcs": "phpcs --standard=phpcs.xml --extensions=php src/ tests/",
"phpdoc": "phpdoc && sed -i \"s/'/'/g\" docs/php/README.md",
"phpunit": "phpunit"
}
}
Loading

0 comments on commit 4528c9d

Please sign in to comment.