aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcash <cash@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-10-01 12:19:46 +0000
committercash <cash@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-10-01 12:19:46 +0000
commit075e8f540f63b7ef72997fd8f0f976eecf84b4b6 (patch)
treeb5534bf2f19b4d7eedb069d7af4a696bec2445aa
parent6e0c8998901bcae422a41d630c8cb95441239f7b (diff)
downloadelgg-075e8f540f63b7ef72997fd8f0f976eecf84b4b6.tar.gz
elgg-075e8f540f63b7ef72997fd8f0f976eecf84b4b6.tar.bz2
restored some documentation that I accidently blew away in previous commit
git-svn-id: http://code.elgg.org/elgg/trunk@6992 36083f99-b078-4883-b0ff-0f9b5a30f544
-rw-r--r--engine/settings.example.php40
1 files changed, 32 insertions, 8 deletions
diff --git a/engine/settings.example.php b/engine/settings.example.php
index aa50be6bc..e6857e4c4 100644
--- a/engine/settings.example.php
+++ b/engine/settings.example.php
@@ -29,22 +29,46 @@ if (!isset($CONFIG)) {
* to explain, but if you know you need it, skip past this section.
*/
-// Database username
+/**
+ * The database username
+ *
+ * @global string $CONFIG->dbuser
+ * @name $CONFIG->dbuser
+ */
$CONFIG->dbuser = '{{dbuser}}';
-// Database password
+/**
+ * The database password
+ *
+ * @global string $CONFIG->dbpass
+ */
$CONFIG->dbpass = '{{dbpassword}}';
-// Database name
+/**
+ * The database name
+ *
+ * @global string $CONFIG->dbname
+ */
$CONFIG->dbname = '{{dbname}}';
-// Database server
-// (For most configurations, you can leave this as 'localhost')
+/**
+ * The database host.
+ *
+ * For most installations, this is 'localhost'
+ *
+ * @global string $CONFIG->dbhost
+ */
$CONFIG->dbhost = '{{dbhost}}';
-// Database table prefix
-// If you're sharing a database with other applications, you will want to use this
-// to differentiate Elgg's tables.
+/**
+ * The database prefix
+ *
+ * This prefix will be appended to all Elgg tables. If you're sharing
+ * a database with other applications, use a database prefix to namespace tables
+ * in order to avoid table name collisions.
+ *
+ * @global string $CONFIG->dbprefix
+ */
$CONFIG->dbprefix = '{{dbprefix}}';