From 1b2873fc5f05ff27dc9b2a75833b61244b9d6049 Mon Sep 17 00:00:00 2001
From: James Cole <thegrumpydictator@gmail.com>
Date: Thu, 18 Feb 2016 06:28:46 +0100
Subject: [PATCH] Some phpdoc.

---
 app/Http/Controllers/RuleController.php | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/app/Http/Controllers/RuleController.php b/app/Http/Controllers/RuleController.php
index 52cf7fae2e..c604a558e6 100644
--- a/app/Http/Controllers/RuleController.php
+++ b/app/Http/Controllers/RuleController.php
@@ -46,6 +46,8 @@ class RuleController extends Controller
     }
 
     /**
+     * Create a new rule. It will be stored under the given $ruleGroup.
+     *
      * @param RuleGroup $ruleGroup
      *
      * @return View
@@ -88,6 +90,8 @@ class RuleController extends Controller
     }
 
     /**
+     * Delete a given rule.
+     *
      * @param Rule $rule
      *
      * @return View
@@ -106,6 +110,8 @@ class RuleController extends Controller
     }
 
     /**
+     * Actually destroy the given rule.
+     *
      * @param Rule                    $rule
      * @param RuleRepositoryInterface $repository
      *
@@ -266,6 +272,13 @@ class RuleController extends Controller
     }
 
     /**
+     * This method allows the user to test a certain set of rule triggers. The rule triggers are passed along
+     * using the URL parameters (GET), and are usually put there using a Javascript thing.
+     *
+     * This method will parse and validate those rules and create a "TransactionMatcher" which will attempt
+     * to find transaction journals matching the users input. A maximum range of transactions to try (range) and
+     * a maximum number of transactions to return (limit) are set as well.
+     *
      * @param TestRuleFormRequest $request
      *
      * @return \Illuminate\View\View
@@ -275,7 +288,6 @@ class RuleController extends Controller
         // build trigger array from response
         $triggers = $this->getValidTriggerList($request);
 
-
         if (count($triggers) == 0) {
             return Response::json(['html' => '', 'warning' => trans('firefly.warning_no_valid_triggers')]);
         }