chore: grammatical issues in comments fixed (#210)

Author: hisorange

src/Contracts/ParserInterface.php

@@ -10,7 +10,7 @@
 interface ParserInterface
 {
     /**
-     * Get a result object from the current visitors user agent string.
+     * Get a result object from the current visitor user agent string.
      *
      * @return ResultInterface
      */

src/Contracts/PayloadInterface.php

@@ -28,7 +28,7 @@ public function setValue(string $key, $value): void;
 
     /**
      * Get a value if exists in the data schema,
-     * returns null if the key does not exists.
+     * returns null if the key does not exist.
      *
      * @param string $key Temporary data key.
      *

src/Contracts/ResultInterface.php

@@ -26,21 +26,21 @@ public function __construct(array $result);
     public function userAgent(): string;
 
     /**
-     * Is this a mobile device.
+     * Is this a mobile device?
      *
      * @return bool
      */
     public function isMobile(): bool;
 
     /**
-     * Is this a tablet device.
+     * Is this a tablet device?
      *
      * @return bool
      */
     public function isTablet(): bool;
 
     /**
-     * Is this a desktop computer.
+     * Is this a desktop computer?
      *
      * @return bool
      */
@@ -54,7 +54,7 @@ public function isDesktop(): bool;
     public function deviceType(): string;
 
     /**
-     * Is this a crawler / bot.
+     * Is this a crawler / bot?
      *
      * @return bool
      */
@@ -89,7 +89,7 @@ public function isOpera(): bool;
     public function isSafari(): bool;
 
     /**
-     * Is this browser an Microsoft Edge?
+     * Is this browser a Microsoft Edge?
      *
      * @return bool
      */
@@ -103,14 +103,14 @@ public function isEdge(): bool;
     public function isIE(): bool;
 
     /**
-     * Is this browser an android in app browser?
+     * Is this browser an android in-app browser?
      *
      * @return bool
      */
     public function isInApp(): bool;
 
     /**
-     * Is this an Internet Explorer X (or lower version).
+     * Is this an Internet Explorer X (or lower version)?
      *
      * @param integer $version
      * @param string  $operator
@@ -120,7 +120,7 @@ public function isInApp(): bool;
     public function isIEVersion(int $version, string $operator = '='): bool;
 
     /**
-     * Build a human readable browser name: Internet Explorer 7, Firefox 3.6
+     * Build a human-readable browser name: Internet Explorer 7, Firefox 3.6
      *
      * @return string
      */
@@ -134,7 +134,7 @@ public function browserName(): string;
     public function browserFamily(): string;
 
     /**
-     * Build human readable browser version. (cuts the trailing .0 parts)
+     * Build a human-readable browser version. (Cuts the trailing .0 parts)
      *
      * @return string
      */
@@ -169,7 +169,7 @@ public function browserVersionPatch(): int;
     public function browserEngine(): string;
 
     /**
-     * Operating system's human friendly name like Windows XP, MacOS 10.
+     * Operating system's human-friendly name like Windows XP, macOS 10.
      *
      * @return string
      */
@@ -183,7 +183,7 @@ public function platformName(): string;
     public function platformFamily(): string;
 
     /**
-     * Build human readable os version. (cuts the trailing .0 parts)
+     * Build a human-readable os version. (cuts the trailing .0 parts)
      *
      * @return string
      */
@@ -225,7 +225,7 @@ public function isWindows(): bool;
     public function isLinux(): bool;
 
     /**
-     * Is this a mac operating system?
+     * Is this a Mac operating system?
      *
      * @return bool
      */

src/Parser.php

@@ -163,7 +163,7 @@ public function parse(string $agent): ResultInterface
         $key = $this->makeHashKey($agent);
 
         if (!isset($this->runtime[$key])) {
-            // In standalone mode You can run the parser without cache.
+            // In standalone mode, You can run the parser without a cache.
             if ($this->cache !== null) {
                 $result = $this->cache->remember(
                     $key,

src/Payload.php

@@ -5,7 +5,7 @@
 use hisorange\BrowserDetect\Contracts\PayloadInterface;
 
 /**
- * This class is passed down in the pipeline
+ * This class is passed down in the pipeline,
  * and each stage makes the changes on this
  * state carrier object.
  *

src/Result.php

@@ -7,7 +7,7 @@
 /**
  * The object is used for safely accessing the
  * result of the parsing, this is necessary
- * to allow us to change the implementaion
+ * to allow us to change the implementation
  * behind the values.
  *
  * @package hisorange\BrowserDetect

src/ServiceProvider.php

@@ -70,7 +70,7 @@ function ($fn) {
     }
 
     /**
-     * Only binding can occure here!
+     * Only binding can occur here!
      *
      * @inheritdoc
      */

src/Stages/BrowserDetect.php

@@ -73,7 +73,7 @@ public function __invoke(PayloadInterface $payload): ResultInterface
             $payload->setValue('isEdge', true);
         }
 
-        // Human readable browser version.
+        // Human-readable browser version.
         $payload->setValue(
             'browserVersion',
             $this->trimVersion(
@@ -94,7 +94,7 @@ public function __invoke(PayloadInterface $payload): ResultInterface
                 $payload->getValue('browserVersion')
         ));
 
-        // Human readable platform version.
+        // Human-readable platform version.
         $payload->setValue(
             'platformVersion',
             $this->trimVersion(

src/Stages/UAParser.php

@@ -7,7 +7,7 @@
 use hisorange\BrowserDetect\Contracts\PayloadInterface;
 
 /**
- * Main parser to get the most of the info about the browser and it's operating system.
+ * Main parser to get the most of the info about the browser, and it's an operating system.
  *
  * @package hisorange\BrowserDetect\Stages
  */