Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: add PHPDoc config, alter Composer script

Browse source
This commit is contained in:
Ben Goldsworthy 2021-04-18 14:23:06 +01:00
parent dd38f27523
commit 6e8ff6b55c
2 changed files with 30 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
composer.json
View file

@ -18,7 +18,7 @@
"lint:js:fix": "npm run lint:js:fix", "lint:js:fix": "npm run lint:js:fix",
"format:js": "npm run format:js", "format:js": "npm run format:js",
"format:js:fix": "npm run format:js:fix", "format:js:fix": "npm run format:js:fix",
"docs": "./vendor/bin/phpdoc -d . -t ./docs --ignore .vendor/ --ignore .node_modules/", "docs": "./vendor/bin/phpdoc",
"commit": "./vendor/bin/php-commitizen commit -- ./.php-commitizen.php", "commit": "./vendor/bin/php-commitizen commit -- ./.php-commitizen.php",
"post-install-cmd": "npm install && ./_tools/setup.sh" "post-install-cmd": "npm install && ./_tools/setup.sh"
}, },

29
phpdoc.dist.xml Normal file
View file

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8" ?>
<phpdocumentor
configVersion="3.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://www.phpdoc.org"
xsi:noNamespaceSchemaLocation="https://docs.phpdoc.org/latest/phpdoc.xsd"
>
<paths>
<output>docs</output>
</paths>
<version number="3.0">
<api format="php">
<source dsn=".">
<path>class</path>
</source>
<output>docs</output>
<ignore hidden="true" symlinks="true">
<path>vendor/*</path>
<path>node-modules/*</path>
</ignore>
<extensions>
<extension>php</extension>
</extensions>
<default-package-name>Footnotes</default-package-name>
<include-source>true</include-source>
</api>
</version>
</phpdocumentor>