CRM-20768 - install - Improve docblock
authorTim Otten <totten@civicrm.org>
Sat, 24 Jun 2017 00:31:14 +0000 (17:31 -0700)
committerTim Otten <totten@civicrm.org>
Sat, 24 Jun 2017 00:54:56 +0000 (17:54 -0700)
install/index.php

index 1339a10d5f39457ea81b291c2b72d5c927fb40dc..79010fffb1af437af52d64dd46f4c3c8a1f07efa 100644 (file)
@@ -555,9 +555,10 @@ class InstallRequirements {
    * This is exactly the same as mysqli_connect(), except that it accepts
    * the port as part of the `$host`.
    *
-   * @param $host
-   * @param $username
-   * @param $password
+   * @param string $host
+   *   Ex: 'localhost', 'localhost:3307', '127.0.0.1:3307', '[::1]', '[::1]:3307'.
+   * @param string $username
+   * @param string $password
    * @param string $database
    * @return \mysqli
    */