Skip to content

[WIP] Experimental/phpdocumentor #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

[WIP] Experimental/phpdocumentor #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
1b581f0
Adding PHPDocumentor
r4j4h Sep 17, 2014
95d646d
Merge branch 'master' into experimental/phpdocumentor
r4j4h Sep 17, 2014
34a7b4e
Merge branch 'master' into experimental/phpdocumentor
r4j4h Sep 23, 2014
926ffc8
Including php-druid-query as src to the docs for better documentation
r4j4h Sep 23, 2014
d0f3e31
Merge branch 'master' into experimental/phpdocumentor
r4j4h Sep 23, 2014
8cd7077
Adding phing phpdocumentor target
r4j4h Sep 24, 2014
89b7cfc
Merge branch 'master' into experimental/phpdocumentor
r4j4h Sep 24, 2014
ceb6668
Merge branch 'master' into experimental/phpdocumentor
r4j4h Sep 24, 2014
fc9117d
Merge branch 'master' into experimental/phpdocumentor
r4j4h Sep 24, 2014
9bedf95
Adding docs to the report target
r4j4h Sep 24, 2014
b5a0b5f
Merge master
r4j4h Sep 24, 2014
e118eed
Merge branch 'master' into experimental/phpdocumentor
r4j4h Feb 13, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
composer.phar
vendor/
build/
config/config.php
config/config.php
docs/main
21 changes: 19 additions & 2 deletions build.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

<target name="clean" description="Clean project from build artifacts">
<delete dir="build"/>
<delete dir="docs/main"/>
</target>


Expand All @@ -18,8 +19,24 @@
<mkdir dir="build/reports"/>
<mkdir dir="build/reports/phpunit"/>
<mkdir dir="build/reports/phpmd"/>
<mkdir dir="docs/main"/>
</target>

<target name="docs" depends="prepare">
<phpdoc2 title="API Documentation"
destdir="docs/main"
template="responsive-twig">
<fileset dir="./src">
<include name="**/*.php" />
</fileset>
<fileset dir="./clicommands">
<include name="**/*.php" />
</fileset>
<fileset dir="./vendor/r4j4h/php-druid-query">
<include name="**/*.php" />
</fileset>
</phpdoc2>
</target>

<target name="phpunit" description="Run PHPUnit on the project">

Expand Down Expand Up @@ -125,8 +142,8 @@

<target name="build" depends="clean,prepare,phpunit"/>

<target name="report" depends="clean,prepare,phpmd,phploc"/>
<target name="report" depends="clean,prepare,phpmd,phploc,docs"/>

<target name="all" depends="build,report"/>

</project>
</project>
7 changes: 5 additions & 2 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,16 @@
"psr/log": "1.0.0",
"guzzle/guzzle": "~3.9",
"symfony/console": "~2.5",
"r4j4h/php-druid-query": "1.0.x-dev"
"r4j4h/php-druid-query": "1.0.x-dev",
"react/promise": "~1.0",
"bcncommerce/json-stream": "*"
},
"require-dev": {
"phpunit/phpunit": "~4",
"phing/phing": "~2",
"phpmd/phpmd": "~2",
"phploc/phploc": "~2"
"phploc/phploc": "~2",
"phpdocumentor/phpdocumentor": "2.*"
},
"autoload": {
"psr-4": {
Expand Down
Loading