Skip to content
This repository has been archived by the owner on Feb 22, 2022. It is now read-only.

Commit

Permalink
生成phpdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
okou19900722 committed Oct 18, 2018
1 parent d45539d commit 0b16b00
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 5 deletions.
5 changes: 1 addition & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 2,5 @@
*.iml
target
generated
vertx-*-jphp
jphp-vertx-extension.properties
changeGitInfo.sh
TestUnit.java
FirstUnitTest.php
FirstUnitTest.php
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,3 135,13 @@ $httpServer->listen();
- [x] VertxExtension 读取jphp-vertx-extension.properties文件并注册wrapper类
- [ ] 使用vertx-docgen自动生成对应的asciidoc文档
- [ ] 测试


#phpdoc

vertx-lang-jphp

- 1、java环境,maven环境,php环境。
- 2、下载[phpdoc](http://www.phpdoc.org/)改名为phpdoc放到vertx-lang-jphp目录下
- 3、下载[graphviz](http://www.graphviz.org/download/) 并配置环境变量

1 change: 1 addition & 0 deletions vertx-lang-jphp/phpdoc.bat
Original file line number Diff line number Diff line change
@@ -0,0 1 @@
php phpdoc.phar -d src/main/generated -t target/phpdoc --template="responsive-twig"
Binary file added vertx-lang-jphp/phpdoc.phar
Binary file not shown.
19 changes: 18 additions & 1 deletion vertx-lang-jphp/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -697,6 697,23 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>1.4.0</version>
<executions>
<execution>
<id>phpdoc</id>
<phase>compile</phase>
<goals>
<goal>exec</goal>
</goals>
<configuration>
<executable>${project.basedir}/phpdoc.bat</executable>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>

Expand All @@ -723,7 740,7 @@
<executions>
<execution>
<configuration>
<sourcepath>${project.build.directory}/sources/vertx/</sourcepath>
<sourcepath>${project.build.directory}/sources/asciidoc/</sourcepath>
<reportOutputDirectory>${project.build.directory}/docs</reportOutputDirectory>
</configuration>
<phase>package</phase>
Expand Down

0 comments on commit 0b16b00

Please sign in to comment.