File tree 3 files changed +28
-0
lines changed
3 files changed +28
-0
lines changed Original file line number Diff line number Diff line change @@ -7,3 +7,6 @@ phpunit.xml
7
7
sample /* /vendor /
8
8
sample /* /cache /
9
9
composer.lock
10
+
11
+ docs /
12
+ .phpdoc /
Original file line number Diff line number Diff line change @@ -20,6 +20,10 @@ This project's tests are written as PHPUnit test cases. Common tasks:
20
20
21
21
* ` ./vendor/bin/phing test ` - run the test suite.
22
22
23
+ ### Building docs
24
+
25
+ Install [ PhpDocumentor] ( https://docs.phpdoc.org/ ) . Then run ` php phpDocumentor.phar --config phpdoc.dist.xml ` .
26
+
23
27
### Releasing
24
28
25
29
In order to create a release, the following should be completed in order.
Original file line number Diff line number Diff line change
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 >
You can’t perform that action at this time.
0 commit comments