docs: add doc comment

kenjis · MGatner · commit fbc46bb9db67 · 2022-12-22T02:31:14.000Z
diff --git a/system/HTTP/RequestTrait.php b/system/HTTP/RequestTrait.php
@@ -44,7 +44,9 @@ trait RequestTrait
     /**
      * Gets the user's IP address.
      *
-     * @return string IP address
+     * @return string IP address if it can be detected, or empty string.
+     *                If the IP address is not a valid IP address,
+     *                then will return '0.0.0.0'.
      */
     public function getIPAddress(): string
     {

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,9 @@ trait RequestTrait`
`44`	`44`	`/**`
`45`	`45`	`* Gets the user's IP address.`
`46`	`46`	`*`
`47`		`- * @return string IP address`
	`47`	`+ * @return string IP address if it can be detected, or empty string.`
	`48`	`+ * If the IP address is not a valid IP address,`
	`49`	`+ * then will return '0.0.0.0'.`
`48`	`50`	`*/`
`49`	`51`	`public function getIPAddress(): string`
`50`	`52`	`{`