From dc36d3095314db8d88c2ec1005d99af595c119da Mon Sep 17 00:00:00 2001
From: Morris Jobke <hey@morrisjobke.de>
Date: Mon, 19 May 2014 17:50:53 +0200
Subject: Remove all occurences of @brief and @returns from PHPDoc

* test case added to avoid adding them later
---
 build/build.xml | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

(limited to 'build')

diff --git a/build/build.xml b/build/build.xml
index 0f9d3605da1..265beb4bccf 100644
--- a/build/build.xml
+++ b/build/build.xml
@@ -40,6 +40,26 @@
    </fileset>
 
   </apply>
+
+  <!-- this looks for @brief and @returns annotation in PHP files and fails if it found some -->
+  <apply executable="egrep" failonerror="false" resultproperty="grepReturnCode">
+    <arg value="-rsHn" />
+    <arg value="@brief|@returns" />
+
+    <fileset dir="${basedir}/build">
+      <include name="**/*.php" />
+      <exclude name="**/3rdparty/**" />
+      <exclude name="**/l10n/**" />
+    </fileset>
+  </apply>
+
+  <!-- fail if grep has found something -->
+  <fail message="Please remove @returns and @brief annotations for PHPDoc (listed above)">
+    <condition>
+      <equals arg1="0" arg2="${grepReturnCode}"/>
+    </condition>
+  </fail>
+
  </target>
 
  <!-- javascript lint -->
-- 
cgit v1.2.3