Skip to content

Commit 47bc16e

Browse files
committedMar 10, 2022
New phpdoc config file
1 parent a8a1674 commit 47bc16e

File tree

3 files changed

+28
-0
lines changed

3 files changed

+28
-0
lines changed
 

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,6 @@ phpunit.xml
77
sample/*/vendor/
88
sample/*/cache/
99
composer.lock
10+
11+
docs/
12+
.phpdoc/

‎DEVELOPING.md

+4
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ This project's tests are written as PHPUnit test cases. Common tasks:
2020

2121
* `./vendor/bin/phing test` - run the test suite.
2222

23+
### Building docs
24+
25+
Install [PhpDocumentor](https://docs.phpdoc.org/). Then run `php phpDocumentor.phar --config phpdoc.dist.xml`.
26+
2327
### Releasing
2428

2529
In order to create a release, the following should be completed in order.

‎phpdoc.dist.xml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<phpdocumentor
3+
configVersion="3"
4+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5+
xmlns="https://www.phpdoc.org"
6+
xsi:noNamespaceSchemaLocation="https://docs.phpdoc.org/latest/phpdoc.xsd"
7+
>
8+
<paths>
9+
<output>docs</output>
10+
</paths>
11+
<version number="latest">
12+
<api>
13+
<source dsn=".">
14+
<path>src</path>
15+
</source>
16+
<ignore hidden="true" symlinks="true">
17+
<path>src/OpenTok/Util</path>
18+
</ignore>
19+
</api>
20+
</version>
21+
</phpdocumentor>

0 commit comments

Comments
 (0)
Please sign in to comment.