Schlaefer / Saito

app/Console/Command/DummyDataShell.php

Doc Comments +4 added lines

@@ -106,6 +106,10 @@
 			$this->out("Generated $i users.");
 		}
 
+		/**
+		 * @param integer $i
+		 * @param integer $off
+		 */
 		protected function _progress($i, $off) {
 			if ($i < 1) {
 				return;

app/Console/Command/SiegeShell.php

Doc Comments +6 added lines

@@ -42,12 +42,18 @@
 			exec($command);
 		}
 
+		/**
+		 * @param string $urlFilePath
+		 */
 		protected function _cleanup($urlFilePath) {
 			if (file_exists($urlFilePath)) {
 				unlink($urlFilePath);
 			}
 		}
 
+		/**
+		 * @param string[] $out
+		 */
 		protected function _generateEntriesIndex(&$out) {
 			for ($i = 0; $i < 400; $i++) {
 				$out[] = $this->_prefix . 'entries/index/page:' . rand(1, 2);

app/Controller/AdminsController.php

Doc Comments +8 added lines

@@ -104,6 +104,10 @@ 
 			return $this->_countYearStats(['fields' => ['COUNT(DISTINCT `user_id`) AS `count`']]);
 		}
 
+		/**
+		 * @param string $model
+		 * @param string $field
+		 */
 		protected function _getYearStats($model, $field) {
 			return $this->_countYearStats(['fields' => ['COUNT(*) AS `count`']],
 					[], $model, $field);
@@ -147,6 +151,10 @@ 
 			return $this->_wrapData($data);
 		}
 
+		/**
+		 * @param string $model
+		 * @param string $field
+		 */
 		protected function _getMonthStats($model, $field) {
 			$results = $this->_countYearStats(
 					['fields' => ['COUNT(*) AS `count`']],

app/Controller/Component/Auth/Mlf2PasswordHasher.php

Doc Comments +3 added lines

@@ -15,6 +15,9 @@
 			return $hashWithSalt;
 		}
 
+		/**
+		 * @param integer $maxLength
+		 */
 		protected static function _generateRandomString($maxLength = null) {
 			$string = Security::generateAuthKey();
 			if ($maxLength) {

app/Controller/Component/CurrentUserComponent.php

Doc Comments +1 added lines

@@ -268,6 +268,7 @@
 
 /**
  * write the settings to the session, so that they are available on next request
+ * @param Controller $controller
  */
 		protected function _writeSession(&$controller) {
 			if ($controller->action !== 'logout' && $controller->Auth->user()):

app/Controller/Component/SaitoEmailComponent.php

Doc Comments +3 added lines

@@ -203,6 +203,9 @@
 			$this->_CakeEmail->config('saito');
 		}
 
+		/**
+		 * @param string $type
+		 */
 		public function getPredefinedSender($type) {
 			$this->_init();
 			return ['User' => [

app/Controller/EntriesController.php

Doc Comments +7 added lines, -1 removed lines

@@ -650,7 +650,7 @@ 
  * @param null $id
  * @param null $toggle
  *
- * @return translated
+ * @return null|string
  */
 		public function ajax_toggle($id = null, $toggle = null) {
 			$this->autoLayout = false;
@@ -781,6 +781,9 @@ 
 			}
 		}
 
+		/**
+		 * @param string $type
+		 */
 		protected function _incrementViews($entry, $type = null) {
 			if ($this->CurrentUser->isBot()) {
 				return;
@@ -947,6 +950,9 @@ 
 			$this->set('rootEntry', $_rootEntry);
 		}
 
+		/**
+		 * @param string $type
+		 */
 		protected function _setTitleFromEntry($entry, $type = null) {
 			if ($type === null) {
 				$template =	__(':subject | :category');

app/Controller/StatusController.php

Doc Comments +6 added lines

@@ -28,6 +28,9 @@ 
 			}
 		}
 
+		/**
+		 * @param string $data
+		 */
 		protected function _statusAsEventStream($data) {
 			// time in ms to next request
 			$_retry = '10000';
@@ -40,6 +43,9 @@ 
 			return $_out;
 		}
 
+		/**
+		 * @param string $data
+		 */
 		protected function _statusAsJson($data) {
 			if ($this->request->is('ajax') === false) {
 				throw new BadRequestException();

app/Controller/UsersController.php

Doc Comments +4 added lines, -1 removed lines

@@ -221,6 +221,9 @@ 
 			$this->_ignore($blockedId, false);
 		}
 
+		/**
+		 * @param boolean $set
+		 */
 		protected function _ignore($blockedId, $set) {
 			if (!$this->CurrentUser->isLoggedIn() || !is_numeric($blockedId)) {
 				throw new BadRequestException();
@@ -661,7 +664,7 @@ 
 		 *
 		 * @param SaitoUser $CurrentUser
 		 * @param int $userId
-		 * @return type
+		 * @return boolean
 		 */
 		protected function _isEditingAllowed(\Saito\User\ForumsUserInterface $CurrentUser, $userId) {
 			if ($CurrentUser->isAdmin()) {