docs: update readme and PHPDoc settings (#120)

* update readme.txt

* Test

* Test

* docs: update documentation

* docs: add package tag

* docs: add PHPDoc config, alter Composer script

Co-authored-by: Rumperuu <me+footnotes@bengoldsworthy.net>
This commit is contained in:
Mark Cheret 2021-04-18 21:30:42 +02:00 committed by GitHub
parent 226df694a2
commit 4dd3345685
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
44 changed files with 10272 additions and 12004 deletions

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>