Permalink
Browse files

Add Ant target to run phpDocumentor

  • Loading branch information...
1 parent a12d56f commit 837a416cbb1acd0935784ec67cbadacf3f2a2ceb @mbabker mbabker committed Sep 2, 2013
Showing with 21 additions and 0 deletions.
  1. +3 −0 .gitignore
  2. +17 −0 build.xml
  3. +1 −0 build/.gitignore
View
@@ -17,3 +17,6 @@
# Test Related Files #
/phpunit.xml
/tests/system/webdriver/tests/logs/
+
+# phpDocumentor Logs #
+phpdoc-*
View
@@ -5,10 +5,12 @@
<property name="joomlasource" value="administrator,cli,components,includes,installation,language/en-GB,libraries/cms,modules,plugins,templates" />
<target name="clean" description="Clean up and create artifact directories">
+ <delete dir="${basedir}/build/api" />
<delete dir="${basedir}/build/coverage" />
<delete dir="${basedir}/build/logs" />
<delete dir="${basedir}/build/pdepend" />
+ <mkdir dir="${basedir}/build/api" />
<mkdir dir="${basedir}/build/coverage" />
<mkdir dir="${basedir}/build/logs" />
<mkdir dir="${basedir}/build/pdepend" />
@@ -59,6 +61,21 @@
</exec>
</target>
+ <target name="phpdoc" description="Generate API documentation using phpDocumentor">
+ <exec executable="phpdoc">
+ <arg value="-d" />
+ <arg path="${basedir}/libraries/cms/,${basedir}/libraries/joomla/,${basedir}/libraries/legacy/" />
+ <arg value="-f" />
+ <arg path="${basedir}/libraries/loader.php,${basedir}/libraries/platform.php" />
+ <arg value="-t" />
+ <arg path="${basedir}/build/api/" />
+ <arg value="--template" />
+ <arg value="joomla" />
+ <arg value="--title" />
+ <arg value="Joomla! CMS API" />
+ </exec>
+ </target>
+
<target name="lint" description="Perform syntax check of sourcecode files">
<apply executable="php" failonerror="true">
<arg value="-l" />
View
@@ -1,4 +1,5 @@
# Ignore test report folders so they do not push to the repo #
+/api
/coverage
/logs
/pdepend

0 comments on commit 837a416

Please sign in to comment.