From 69abbcaf4bb295579329aa47ad40decba956b4c4 Mon Sep 17 00:00:00 2001
From: ardent <tim.veenendaal@gmail.com>
Date: Mon, 27 Jul 2020 01:23:13 +0200
Subject: [PATCH] Improve phpdocs of service

---
 Service/ParameterService.php | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/Service/ParameterService.php b/Service/ParameterService.php
index 0c7b23b..797440d 100644
--- a/Service/ParameterService.php
+++ b/Service/ParameterService.php
@@ -33,10 +33,10 @@ class ParameterService
     }
 
     /**
-     * @param string $name
-     * @param bool $parse
+     * @param string $name The name of the parameter in the format <group>_<parameter>
+     * @param bool $parse Whether to parse embedded %parameter%'s
      *
-     * @return string
+     * @return mixed
      */
     public function get($name, $parse = true)
     {
@@ -67,8 +67,8 @@ class ParameterService
     }
 
     /**
-     * @param $name
-     * @param $value
+     * @param string $name The name of the parameter in the format <group>_<parameter>
+     * @param mixed $value
      */
     public function set($name, $value)
     {
@@ -103,6 +103,7 @@ class ParameterService
                         break;
                 }
 
+                // Add the group name in front of the parameter name
                 $value['name'] = sprintf('%s_%s', $groupName, $value['name']);
                 $value['type'] = $class;
                 unset($value);