Skip to content

Commit 81964f1

Browse files
committed
feat: phpdoc
1 parent 3f98d9c commit 81964f1

File tree

3 files changed

+14
-15
lines changed

3 files changed

+14
-15
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,5 @@ composer.lock
77
.php-cs-fixer.cache
88
.phpunit.result.cache
99
.envrc
10+
build/
11+
.phpdoc/

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ fmtcheck: vendor ## Check code formatting
2020

2121
.PHONY: docs
2222
docs: vendor ## Generate API reference using phpDocumentor
23-
vendor/bin/phpdoc --config=phpdoc.dist.xml
23+
docker run --rm -v "$(pwd):/data" "phpdoc/phpdoc:3"
2424

2525
.PHONY: test
2626
test: vendor ## Run PHPUnit test suite

phpdoc.dist.xml

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,31 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<phpdocumentor
33
configVersion="3"
4-
xmlns="https://www.phpdoc.org"
54
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5+
xmlns="http://www.phpdoc.org"
66
xsi:noNamespaceSchemaLocation="data/xsd/phpdoc.xsd"
77
>
8-
<title>SumUp Ecommerce PHP SDK</title>
98
<paths>
10-
<output>docs</output>
11-
<cache>build/phpdoc/cache</cache>
9+
<output>build/phpdoc</output>
1210
</paths>
13-
<version number="latest">
14-
<api ignore-packages="true">
15-
<source>
11+
<version number="3.0.0">
12+
<folder>latest</folder>
13+
<api>
14+
<source dsn=".">
1615
<path>src</path>
1716
</source>
1817
<output>api</output>
1918
<ignore hidden="true" symlinks="true">
20-
<path>vendor/**/*</path>
19+
<path>build/**/*</path>
20+
<path>examples/**/*</path>
2121
<path>tests/**/*</path>
22-
<path>codegen/**/*</path>
22+
<path>vendor/**/*</path>
2323
</ignore>
2424
<extensions>
2525
<extension>php</extension>
2626
</extensions>
27-
<visibility>public</visibility>
28-
<visibility>protected</visibility>
29-
<default-package-name>SumUp Ecommerce SDK</default-package-name>
27+
<default-package-name>sumup-php</default-package-name>
3028
</api>
3129
</version>
32-
<setting name="graphs.enabled" value="false" />
33-
<template name="clean"/>
30+
<template name="default"/>
3431
</phpdocumentor>

0 commit comments

Comments
 (0)