opengovfoundation / madison

app/BillImport.php

Doc Comments +3 added lines

@@ -83,6 +83,7 @@ 
 
     /**
      * 	Recursive function to save children of a given node as DocContent items.
+     * @param integer $child_priority
      */
     public function saveChildren($node, $parent_id, $child_priority)
     {
@@ -189,6 +190,7 @@ 
 
     /**
      * 	Get top-level meta information from the bill.
+     * @param string $tag
      */
     public function getBillMeta($tag)
     {
@@ -233,6 +235,7 @@ 
     /**
      * 	Check attributes are set
      * 	Accepts single string or array of strings.
+     * @param string $attribute
      */
     protected function checkAttr($attribute)
     {

Unused Use Statements -2 removed lines

@@ -2,8 +2,6 @@
 
 namespace App;
 
-use Illuminate\Database\Eloquent\Model;
-
 /**
  * 	Import Class for House Bill XML
  * 	Not pretty at the moment, but it works.

app/Console/Commands/DatabaseBackup.php

Doc Comments +13 added lines

@@ -44,6 +44,10 @@ 
     }
 
     //Create backups directory if it doesn't exist
+
+    /**
+     * @param string $backups_path
+     */
     public function setup($backups_path)
     {
         if (!file_exists($backups_path)) {
@@ -53,6 +57,10 @@ 
     }
 
     //Run mysqldump and include timestamp in file name
+
+    /**
+     * @param string $backups_path
+     */
     public function backup($backups_path)
     {
         $creds = yaml_parse_file(app_path().'/config/creds.yml');
@@ -65,6 +73,11 @@ 
     }
 
     //Limit number of saved backups
+
+    /**
+     * @param string $backups_path
+     * @param integer $total_backups
+     */
     public function cleanup($backups_path, $total_backups)
     {
         $files = glob($backups_path.'/*.sql');

app/Doc.php

Doc Comments +3 added lines

@@ -502,6 +502,9 @@
         return $path;
     }
 
+    /**
+     * @param DocContent $doc_content
+     */
     public function indexContent($doc_content)
     {
         $es = self::esConnect();

app/Group.php

Doc Comments +3 added lines, -3 removed lines

@@ -125,9 +125,6 @@ 
      *
      *	Validate input against merged rules
      *
-     *	@param array $attributes
-     *
-     *	@return bool
      */
     public function validate()
     {
@@ -400,6 +397,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $role
+     */
     public static function findUsersByRole($role)
     {
         if (!static::isValidRole($role)) {

Unused Use Statements -1 removed lines

@@ -10,7 +10,6 @@
 use Illuminate\Support\MessageBag;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\SoftDeletes;
-
 use App\GroupMember;
 use App\Role;
 use App\Permission;

app/Http/Controllers/Controller.php

Doc Comments +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
     /**
      *	Helper function to return error as growl message.
      *
-     *	@param string $message
+     *	@param string $messages
      *	@param string $severity
      *  @param array $params
      *

app/Http/Controllers/UserController.php

Doc Comments +2 added lines, -3 removed lines

@@ -146,7 +146,7 @@ 
      *
      * @param User $user
      *
-     * @return array $response
+     * @return \Illuminate\Http\JsonResponse $response
      */
     public function editEmail(User $user)
     {
@@ -177,7 +177,7 @@ 
      *
      *	@param void
      *
-     * @return JSON user
+     * @return \Illuminate\Http\JsonResponse user
      */
     public function getCurrent()
     {
@@ -429,7 +429,6 @@ 
      *
      *	Handles POST requests for email verifications
      *
-     *	@param string $token
      */
     public function postVerify()
     {

app/StringDiff.php

Doc Comments +3 added lines, -3 removed lines

@@ -38,7 +38,7 @@ 
     private static $divisor = 0;
 
     /**
-     * @return the CSS needed to display diff/overlap results in html
+     * @return string CSS needed to display diff/overlap results in html
      */
     public static function getCSS()
     {
@@ -121,7 +121,7 @@ 
      * @param string $s
      * @param string $middle
      *
-     * @return array (head, middle, tail)
+     * @return string[] (head, middle, tail)
      */
     public static function tripartite($s, $middle)
     {
@@ -222,7 +222,7 @@ 
      * position in achars to the mapped contiguous array of elements.
      *
      * @param array        $idmap
-     * @param unknown_type $alen
+     * @param integer $alen
      * @param array        $achars
      *
      * @return multitype:multitype:Ambigous <>  Ambigous <>

app/User.php

Doc Comments +8 added lines, -9 removed lines

@@ -179,7 +179,7 @@ 
      *
      * @param void
      *
-     * @return Illuminate\Database\Eloquent\Relations\BelongsToMany
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
      */
     public function docs()
     {
@@ -230,7 +230,7 @@ 
      *
      *	@param void
      *
-     *	@return Illuminate\Database\Eloquent\Relations\BelongsToMany
+     *	@return \Illuminate\Database\Eloquent\Relations\BelongsToMany
      */
     public function groups()
     {
@@ -244,7 +244,7 @@ 
      *
      *	@param void
      *
-     *	@return Illuminate\Database\Eloquent\Relations\HasMany
+     *	@return \Illuminate\Database\Eloquent\Relations\HasMany
      */
     public function comments()
     {
@@ -258,7 +258,7 @@ 
      *
      *	@param void
      *
-     *	@return Illuminate\Database\Eloquent\Relations\HasMany
+     *	@return \Illuminate\Database\Eloquent\Relations\HasMany
      */
     public function annotations()
     {
@@ -317,7 +317,7 @@ 
      *
      *	@param void
      *
-     *	@return Illuminate\Database\Eloquent\Relations\BelongsTo
+     *	@return \Illuminate\Database\Eloquent\Relations\BelongsTo
      *
      *	@todo This can be removed as we use Groups in place of Organizations
      */
@@ -333,7 +333,7 @@ 
      *
      *	@param void
      *
-     *	@return Illuminate\Database\Eloquent\Relations\HasMany
+     *	@return \Illuminate\Database\Eloquent\Relations\HasMany
      */
     public function note_meta()
     {
@@ -347,7 +347,7 @@ 
      *
      *	@param void
      *
-     *	@return Illuminate\Database\Eloquent\Relations\HasMany
+     *	@return \Illuminate\Database\Eloquent\Relations\HasMany
      */
     public function user_meta()
     {
@@ -451,7 +451,7 @@ 
      *
      *	@param void
      *
-     *	@return Illuminate\Database\Eloquent\Relations\HasMany
+     *	@return \Illuminate\Database\Eloquent\Relations\HasMany
      */
     public function doc_meta()
     {
@@ -586,7 +586,6 @@ 
      *
      *	Validate input against merged rules
      *
-     *	@param array $attributes
      *
      * @return bool
      */

Unused Use Statements -2 removed lines

@@ -15,12 +15,10 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Session;
-
 use App\Group;
 use App\GroupMember;
 use App\Role;
 use App\UserMeta;
-
 use Zizaco\Entrust\Traits\EntrustUserTrait;
 
 class User extends Model implements AuthenticatableContract, CanResetPasswordContract

app/Annotation.php

Doc Comments +8 added lines, -1 removed lines

@@ -321,6 +321,10 @@ 
         return $item;
     }
 
+    /**
+     * @param integer $docId
+     * @param string $annotationId
+     */
     public static function loadAnnotationsForAnnotator($docId, $annotationId = null, $userId = null)
     {
         $annotations = static::where('doc_id', '=', $docId);
@@ -416,6 +420,9 @@ 
         return $obj;
     }
 
+    /**
+     * @param string $action
+     */
     public static function getMetaCount($id, $action)
     {
         $annotation = static::where('annotation_id', '=', $id);
@@ -477,7 +484,7 @@ 
      *
      *   @param null
      *
-     *   @return url
+     *   @return string
      */
     public function getLink()
     {