From c51d2fc6720daae471090ed8a7ab73b241730d34 Mon Sep 17 00:00:00 2001
From: Dorian Neto <doriansampaioneto@gmail.com>
Date: Tue, 26 Sep 2017 18:36:06 -0300
Subject: [PATCH] Comments added in validator file methods

---
 src/ProfaneValidator.php | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/src/ProfaneValidator.php b/src/ProfaneValidator.php
index 769884f..e7437c2 100644
--- a/src/ProfaneValidator.php
+++ b/src/ProfaneValidator.php
@@ -7,9 +7,15 @@ use Illuminate\Contracts\Validation\Validator;
 
 class ProfaneValidator
 {
-
+    /**
+     * [$badwords description]
+     * @var array
+     */
     protected $badwords = [];
 
+    /**
+     * [__construct description]
+     */
     function __construct()
     {
         // Get default locale string in laravel project
@@ -49,6 +55,10 @@ class ProfaneValidator
         );
     }
 
+    /**
+     * [getBadwords description]
+     * @return [type] [description]
+     */
     public function getBadwords()
     {
         return $this->badwords;
@@ -63,6 +73,11 @@ class ProfaneValidator
         $this->badwords = $this->readDictionary($dictionary);
     }
 
+    /**
+     * [readDictionary description]
+     * @param  [type] $dictionary [description]
+     * @return [type]             [description]
+     */
     protected function readDictionary($dictionary)
     {
         $badwords = [];
@@ -95,6 +110,10 @@ class ProfaneValidator
         return $badwords;
     }
 
+    /**
+     * [getBaseDictPath description]
+     * @return [type] [description]
+     */
     protected function getBaseDictPath()
     {
         return property_exists($this, 'baseDictPath') ? $this->baseDictPath : __DIR__ . DIRECTORY_SEPARATOR .'dict/';