Friendica/friendica-github
1
0
Fork 0
mirror of https://github.com/friendica/friendica synced 2024-12-22 13:20:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

Replace build.xml with mods/phpdoc-config.xml

Browse source
This commit is contained in:
Philipp 2021-05-29 22:37:28 +02:00
parent dd63c243ab
commit 6f83a70c47
No known key found for this signature in database
GPG key ID: 9A28B7D4FF5667BD
3 changed files with 26 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.gitignore vendored
View file

@ -16,7 +16,8 @@ robots.txt
/config/addon.ini.php
#ignore documentation, it should be newly built
/doc/html
/doc/api
/doc/cache
#ignore reports, should be generated with every build
report/

76
build.xml
View file

@ -1,76 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project name="friendica" default="test">
<!-- ====================================================== -->
<!-- Target: clean-test -->
<!-- deletes directories with old test reports -->
<!-- ====================================================== -->
<target name="clean-test">
<delete dir="report" />
</target>
<!-- ====================================================== -->
<!-- Target: prepare-test -->
<!-- creates directories for test reports -->
<!-- ====================================================== -->
<target name="prepare-test" depends="clean-test">
<mkdir dir="report" />
</target>
<!-- =================================== -->
<!-- Target: test -->
<!-- this target runs all test files -->
<!-- =================================== -->
<target name="test" depends="prepare-test">
<!-- coverage-setup database="./report/coverage-database">
<fileset dir=".">
<include name="**/*.php" />
<exclude name="*test.php"/>
<exclude name="index.php"/>
<exclude name="library/**"/>
<exclude name="doc/**"/>
<exclude name=".."/>
</fileset>
</coverage-setup -->
<phpunit printsummary="true">
<batchtest>
<fileset dir="tests">
<include name="*test.php" />
</fileset>
</batchtest>
<formatter type="xml" todir="report" outfile="testlog.xml" />
</phpunit>
<phpunitreport infile="report/testlog.xml" todir="report" />
<!-- coverage-report outfile="report/coverage-database">
<report todir="report" styledir="/home/phing/etc" />
</coverage-report -->
</target>
<!-- ===================================================== -->
<!-- Target: clean-doc -->
<!-- this target removes documentation from a previous run -->
<!-- ===================================================== -->
<target name="doc-clean">
<echo msg="Removing old documentation..." />
<delete dir="./doc/api/" />
<echo msg="Generate documentation directory..." />
<mkdir dir="./doc/api/" />
</target>
<!-- ====================================== -->
<!-- Target: doc -->
<!-- this target builds all documentation -->
<!-- ====================================== -->
<target name="doc" depends="doc-clean">
<echo msg="Building documentation..." />
<docblox title="Friendica API" destdir="./doc/api">
<fileset dir=".">
<include name="**/*.php" />
<include name="README"/>
<include name="INSTALL.txt"/>
<include name="LICENSE"/>
</fileset>
</docblox>
</target>
</project>

24
mods/phpdoc-config.xml Normal file
View file

@ -0,0 +1,24 @@
<?xml version="1.0" encoding="utf-8" ?>
<phpdocumentor xmlns="https://www.phpdoc.org" configVersion="3.0">
<paths>
<output>../doc/api</output>
<cache>../doc/cache</cache>
</paths>
<version number="3.0">
<api>
<source dsn="../">
<path>src</path>
<path>mod</path>
<path>include</path>
<path>static</path>
<path>bin</path>
<path>view</path>
</source>
<ignore>
<path>vendor/**/*</path>
<path>asset/**/*</path>
<path>bin/dev/**/*</path>
</ignore>
</api>
</version>
</phpdocumentor>