Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs with phpDocumentor #18

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Docs with phpDocumentor #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
**/*.checksum
/composer.lock
/composer.phar
/docs/cache/
/tests/scripts/output/*.checksum
/tests/scripts/output/*.sql
/vendor/
Expand Down
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,14 @@ docker-compose exec -w /app/tests/scripts php80 ./test.sh db3
docker-compose exec -w /app/tests/scripts php81 ./test.sh db3
```

## Docs

Docs can be created by running:

```
docker run --rm -v "$(pwd):/data" "phpdoc/phpdoc:3"
```

## Credits

Forked from Diego Torres's version which have latest updates from 2020. Use it for PHP 7.3 and older.
Expand Down
21 changes: 21 additions & 0 deletions phpdoc.dist.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8" ?>
<phpdocumentor
configVersion="3"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://www.phpdoc.org"
xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/phpDocumentor/phpDocumentor/master/data/xsd/phpdoc.xsd"
>
<title>mysqldump-php</title>
<paths>
<output>docs/api</output>
<cache>docs/cache</cache>
</paths>
<version number="3.0.0">
<api>
<source dsn=".">
<path>src</path>
</source>
<default-package-name>Druidfi\Mysqldump</default-package-name>
</api>
</version>
</phpdocumentor>