From 1f448f9b1e731688133a943fe451c3d73a3ae0c4 Mon Sep 17 00:00:00 2001
From: mistic100 <mistic@piwigo.org>
Date: Fri, 24 Jan 2014 12:50:48 +0000
Subject: feature 2999; docblocks for history, install and metadata

git-svn-id: http://piwigo.org/svn/trunk@26946 68402e56-0260-453c-a942-63ccdbb3a9ee
---
 admin/include/functions_install.inc.php | 24 ++++++++++++++++--------
 1 file changed, 16 insertions(+), 8 deletions(-)

(limited to 'admin/include/functions_install.inc.php')

diff --git a/admin/include/functions_install.inc.php b/admin/include/functions_install.inc.php
index 9e479f54b..43043a0b0 100644
--- a/admin/include/functions_install.inc.php
+++ b/admin/include/functions_install.inc.php
@@ -22,16 +22,19 @@
 // +-----------------------------------------------------------------------+
 
 /**
- * loads an sql file and executes all queries
- *
+ * @package functions\admin\install
+ */
+
+
+/**
+ * Loads a SQL file and executes all queries.
  * Before executing a query, $replaced is... replaced by $replacing. This is
  * useful when the SQL file contains generic words. Drop table queries are
  * not executed.
  *
- * @param string filepath
- * @param string replaced
- * @param string replacing
- * @return void
+ * @param string $filepath
+ * @param string $replaced
+ * @param string $replacing
  */
 function execute_sqlfile($filepath, $replaced, $replacing, $dblayer)
 {
@@ -70,8 +73,6 @@ function execute_sqlfile($filepath, $replaced, $replacing, $dblayer)
 
 /**
  * Automatically activate all core themes in the "themes" directory.
- *
- * @return void
  */
 function activate_core_themes()
 {
@@ -86,6 +87,12 @@ function activate_core_themes()
   }
 }
 
+/**
+ * Connect to database during installation. Uses $_POST.
+ *
+ * @param array &$infos - populated with infos
+ * @param array &$errors - populated with errors
+ */
 function install_db_connect(&$infos, &$errors)
 {
   try
@@ -99,4 +106,5 @@ function install_db_connect(&$infos, &$errors)
     $errors[] = l10n($e->getMessage());
   }
 }
+
 ?>
\ No newline at end of file
-- 
cgit v1.2.3