From bad41c05b80f22954d88120fa220b13cd5de5c4f Mon Sep 17 00:00:00 2001
From: Bart Visscher <bartv@thisnet.nl>
Date: Mon, 14 Apr 2014 17:39:29 +0200
Subject: [PATCH] Fix PHPdoc in user_ldap

using scrutinizer patch
---
 apps/user_ldap/group_ldap.php       | 11 +++++++++++
 apps/user_ldap/lib/access.php       |  4 ++--
 apps/user_ldap/lib/connection.php   |  3 +++
 apps/user_ldap/lib/proxy.php        |  3 +++
 apps/user_ldap/lib/wizard.php       |  4 ++--
 apps/user_ldap/lib/wizardresult.php |  3 +++
 6 files changed, 24 insertions(+), 4 deletions(-)

diff --git a/apps/user_ldap/group_ldap.php b/apps/user_ldap/group_ldap.php
index 40d9dec141..3b5f377e10 100644
--- a/apps/user_ldap/group_ldap.php
+++ b/apps/user_ldap/group_ldap.php
@@ -88,6 +88,10 @@ class GROUP_LDAP extends BackendUtility implements \OCP\GroupInterface {
 		return $isInGroup;
 	}
 
+	/**
+	 * @param string $dnGroup
+	 * @param array|null &$seen
+	 */
 	private function _groupMembers($dnGroup, &$seen = null) {
 		if ($seen === null) {
 			$seen = array();
@@ -163,6 +167,10 @@ class GROUP_LDAP extends BackendUtility implements \OCP\GroupInterface {
 		return $groups;
 	}
 
+	/**
+	 * @param string $dn
+	 * @param array|null &$seen
+	 */
 	private function getGroupsByMember($dn, &$seen = null) {
 		if ($seen === null) {
 			$seen = array();
@@ -454,6 +462,9 @@ class GROUP_LDAP extends BackendUtility implements \OCP\GroupInterface {
 		return $allGroups;
 	}
 
+	/**
+	 * @param string $group
+	 */
 	public function groupMatchesFilter($group) {
 		return (strripos($group, $this->groupSearch) !== false);
 	}
diff --git a/apps/user_ldap/lib/access.php b/apps/user_ldap/lib/access.php
index 4d187bab8d..383583fce3 100644
--- a/apps/user_ldap/lib/access.php
+++ b/apps/user_ldap/lib/access.php
@@ -923,8 +923,8 @@ class Access extends LDAPUtility {
 
 	/**
 	* @brief escapes (user provided) parts for LDAP filter
-	* @param String $input, the provided value
-	* @returns the escaped string
+	* @param string $input, the provided value
+	* @return the escaped string
 	*/
 	public function escapeFilterPart($input) {
 		$search  = array('*', '\\', '(', ')');
diff --git a/apps/user_ldap/lib/connection.php b/apps/user_ldap/lib/connection.php
index 08ac4ac626..173c4ebcc2 100644
--- a/apps/user_ldap/lib/connection.php
+++ b/apps/user_ldap/lib/connection.php
@@ -134,6 +134,9 @@ class Connection extends LDAPUtility {
 		return $this->ldapConnectionRes;
 	}
 
+	/**
+	 * @param string|null $key
+	 */
 	private function getCacheKey($key) {
 		$prefix = 'LDAP-'.$this->configID.'-'.$this->configPrefix.'-';
 		if(is_null($key)) {
diff --git a/apps/user_ldap/lib/proxy.php b/apps/user_ldap/lib/proxy.php
index b27233bcd1..0eb294eb7a 100644
--- a/apps/user_ldap/lib/proxy.php
+++ b/apps/user_ldap/lib/proxy.php
@@ -80,6 +80,9 @@ abstract class Proxy {
 		return $result;
 	}
 
+	/**
+	 * @param string|null $key
+	 */
 	private function getCacheKey($key) {
 		$prefix = 'LDAP-Proxy-';
 		if(is_null($key)) {
diff --git a/apps/user_ldap/lib/wizard.php b/apps/user_ldap/lib/wizard.php
index 3854af617c..8ddee8c760 100644
--- a/apps/user_ldap/lib/wizard.php
+++ b/apps/user_ldap/lib/wizard.php
@@ -485,7 +485,7 @@ class Wizard extends LDAPUtility {
 	/**
 	 * @brief sets the found value for the configuration key in the WizardResult
 	 * as well as in the Configuration instance
-	 * @param $key the configuration key
+	 * @param string $key the configuration key
 	 * @param $value the (detected) value
 	 * @return null
 	 *
@@ -1000,7 +1000,7 @@ class Wizard extends LDAPUtility {
 	/**
 	 * @brief appends a list of values fr
 	 * @param $result resource, the return value from ldap_get_attributes
-	 * @param $attribute string, the attribute values to look for
+	 * @param string $attribute the attribute values to look for
 	 * @param &$known array, new values will be appended here
 	 * @return int, state on of the class constants LRESULT_PROCESSED_OK,
 	 * LRESULT_PROCESSED_INVALID or LRESULT_PROCESSED_SKIP
diff --git a/apps/user_ldap/lib/wizardresult.php b/apps/user_ldap/lib/wizardresult.php
index 542f106cad..9c154503f5 100644
--- a/apps/user_ldap/lib/wizardresult.php
+++ b/apps/user_ldap/lib/wizardresult.php
@@ -36,6 +36,9 @@ class WizardResult {
 		$this->markedChange = true;
 	}
 
+	/**
+	 * @param string $key
+	 */
 	public function addOptions($key, $values) {
 		if(!is_array($values)) {
 			$values = array($values);