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

diff --git a/engine/settings.example.php b/engine/settings.example.php
index aa50be6bc6f330ec2cd078c0990db8082974a3a3..e6857e4c401067561c53be5f88a772f8f29b8b38 100644 (file)
--- 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}}';