Fix PHPDoc comments project-wide

[friendica.git] / src / Core / Installer.php

diff --git a/src/Core/Installer.php b/src/Core/Installer.php
index 15bcb76f4921f1e10103176d9f4c0721b521598c..6ea3d553cf8a1bf6a96e415edef41273d4aed332 100644 (file)
--- a/src/Core/Installer.php
+++ b/src/Core/Installer.php
@@ -47,6 +47,7 @@ class Installer
         * Returns the PHP path
         *
         * @return string the PHP Path
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public function getPHPPath()
        {
@@ -79,10 +80,11 @@ class Installer
        /**
         * Checks the current installation environment. There are optional and mandatory checks.
         *
-        * @param string $baseurl     The baseurl of Friendica
-        * @param string $phpath      Optional path to the PHP binary
+        * @param string $baseurl The baseurl of Friendica
+        * @param string $phpath  Optional path to the PHP binary
         *
         * @return bool if the check succeed
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public function checkEnvironment($baseurl, $phpath = null)
        {
@@ -126,18 +128,19 @@ class Installer
         * - Creates `config/local.config.php`
         * - Installs Database Structure
         *
-        * @param string        $phppath        Path to the PHP-Binary (optional, if not set e.g. 'php' or '/usr/bin/php')
-        * @param string        $urlpath        Path based on the URL of Friendica (e.g. '/friendica')
-        * @param string        $dbhost         Hostname/IP of the Friendica Database
-        * @param string        $dbuser         Username of the Database connection credentials
-        * @param string        $dbpass         Password of the Database connection credentials
-        * @param string        $dbdata         Name of the Database
-        * @param string        $timezone       Timezone of the Friendica Installaton (e.g. 'Europe/Berlin')
-        * @param string        $language       2-letter ISO 639-1 code (eg. 'en')
-        * @param string        $adminmail      Mail-Adress of the administrator
-        * @param string        $basepath   The basepath of Friendica
+        * @param string $phppath   Path to the PHP-Binary (optional, if not set e.g. 'php' or '/usr/bin/php')
+        * @param string $urlpath   Path based on the URL of Friendica (e.g. '/friendica')
+        * @param string $dbhost    Hostname/IP of the Friendica Database
+        * @param string $dbuser    Username of the Database connection credentials
+        * @param string $dbpass    Password of the Database connection credentials
+        * @param string $dbdata    Name of the Database
+        * @param string $timezone  Timezone of the Friendica Installaton (e.g. 'Europe/Berlin')
+        * @param string $language  2-letter ISO 639-1 code (eg. 'en')
+        * @param string $adminmail Mail-Adress of the administrator
+        * @param string $basepath  The basepath of Friendica
         *
         * @return bool true if the config was created, otherwise false
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public function createConfig($phppath, $urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $timezone, $language, $adminmail, $basepath)
        {
@@ -167,6 +170,7 @@ class Installer
         * Installs the DB-Scheme for Friendica
         *
         * @return bool true if the installation was successful, otherwise false
+        * @throws Exception
         */
        public function installDatabase()
        {
@@ -212,11 +216,12 @@ class Installer
         * - Checks if a PHP binary is available
         * - Checks if it is the CLI version
         * - Checks if "register_argc_argv" is enabled
-        *
-        * @param string $phppath Optional. The Path to the PHP-Binary
+        *
+        * @param string $phppath  Optional. The Path to the PHP-Binary
         * @param bool   $required Optional. If set to true, the PHP-Binary has to exist (Default false)
         *
         * @return bool false if something required failed
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public function checkPHP($phppath = null, $required = false)
        {
@@ -507,8 +512,9 @@ class Installer
         *
         * Checks, if "url_rewrite" is enabled in the ".htaccess" file
         *
-        * @param string $baseurl    The baseurl of the app
+        * @param string $baseurl The baseurl of the app
         * @return bool false if something required failed
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public function checkHtAccess($baseurl)
        {
@@ -576,12 +582,13 @@ class Installer
        /**
         * Checking the Database connection and if it is available for the current installation
         *
-        * @param string        $dbhost         Hostname/IP of the Friendica Database
-        * @param string        $dbuser         Username of the Database connection credentials
-        * @param string        $dbpass         Password of the Database connection credentials
-        * @param string        $dbdata         Name of the Database
+        * @param string $dbhost Hostname/IP of the Friendica Database
+        * @param string $dbuser Username of the Database connection credentials
+        * @param string $dbpass Password of the Database connection credentials
+        * @param string $dbdata Name of the Database
         *
         * @return bool true if the check was successful, otherwise false
+        * @throws Exception
         */
        public function checkDB($dbhost, $dbuser, $dbpass, $dbdata)
        {